home *** CD-ROM | disk | FTP | other *** search
/ PC Online 1999 February / PCO_0299.ISO / filesbbs / linux / mikmod-3.000 / mikmod-3 / mikmod-3.1.2 / docs / mikmod.info-2 < prev    next >
Encoding:
GNU Info File  |  1998-12-07  |  41.9 KB  |  1,481 lines
  1. This is Info file mikmod.info, produced by Makeinfo version 1.68 from
  2. the input file mikmod.texi.
  3.  
  4.    Copyright (C) 1998 Miodrag Vallat and others -- see file AUTHORS for
  5. complete list.
  6.  
  7.    This library is free software; you can redistribute it and/or modify
  8. it under the terms of the GNU Library General Public License as
  9. published by the Free Software Foundation; either version 2 of the
  10. License, or (at your option) any later version.
  11.  
  12.    This program is distributed in the hope that it will be useful, but
  13. WITHOUT ANY WARRANTY; without even the implied warranty of
  14. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15. Library General Public License for more details.
  16.  
  17.    You should have received a copy of the GNU Library General Public
  18. License along with this library; if not, write to the Free Software
  19. Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20.  
  21. INFO-DIR-SECTION Programming
  22. START-INFO-DIR-ENTRY
  23. * MikMod: (mikmod).            MikMod Sound Library.
  24. END-INFO-DIR-ENTRY
  25.  
  26. 
  27. File: mikmod.info,  Node: Library Core Functions,  Next: Module Player Functions,  Prev: Function Reference,  Up: Function Reference
  28.  
  29. Library Core Functions
  30. ----------------------
  31.  
  32. MikMod_Active
  33. .............
  34.  
  35.    `BOOL MikMod_Active(void)'
  36. Description
  37.      This function returns whether sound output is enabled or not.
  38.  
  39. Result
  40. 0
  41.      Sound output is disabled.
  42.  
  43. 1
  44.      Sound output is enabled.
  45.  
  46. Notes
  47.      Calls to `MikMod_Update' will be ignored when sound output is
  48.      disabled.
  49.  
  50. See also
  51.      `MikMod_DisableOutput', `MikMod_EnableOutput'.
  52.  
  53. MikMod_DisableOutput
  54. ....................
  55.  
  56.    `void MikMod_DisableOutput(void)'
  57. Description
  58.      This function stops the sound mixing.
  59.  
  60. Notes
  61.      Calls to `MikMod_Update' will be ignored when sound output is
  62.      disabled.
  63.  
  64. See also
  65.      `MikMod_Active', `MikMod_EnableOutput'.
  66.  
  67. MikMod_EnableOutput
  68. ...................
  69.  
  70.    `BOOL MikMod_EnableOutput(void)'
  71. Description
  72.      This function starts the sound mixing.
  73.  
  74. Result
  75. 0
  76.      Sound mixing is ready.
  77.  
  78. nonzero
  79.      An error occurred during the operation.
  80.  
  81. Notes
  82.      Calls to `MikMod_Update' will be ignored when sound output is
  83.      disabled.
  84.  
  85. See also
  86.      `MikMod_Active', `MikMod_DisableOutput'.
  87.  
  88. MikMod_Exit
  89. ...........
  90.  
  91.    `void MikMod_Exit(void)'
  92. Description
  93.      This function deinitializes the sound hardware and frees all the
  94.      memory and resources used by MikMod.
  95.  
  96. See also
  97.      `MikMod_Init', `MikMod_Reset'.
  98.  
  99. MikMod_GetVersion
  100. .................
  101.  
  102.    `long MikMod_GetVersion(void)'
  103. Description
  104.      This function returns the version number of the library.
  105.  
  106. Result
  107.      The version number, encoded as follows: `(maj<<16)|(min<<8)|(rev)',
  108.      where `maj' is the major version number, `min' is the minor version
  109.      number, and `rev' is the revision number.
  110.  
  111. MikMod_InfoDriver
  112. .................
  113.  
  114.    `CHAR* MikMod_InfoDriver(void)'
  115. Description
  116.      This function returns a formatted list of the registered drivers
  117.      in a buffer.
  118.  
  119. Result
  120.      A pointer to a text buffer, or `NULL' if no drivers are registered.
  121.  
  122. Notes
  123.      The buffer is created with `malloc'; the caller must free it when
  124.      it is no longer necessary.
  125.  
  126. See also
  127.      `MikMod_RegisterDriver', `MikMod_RegisterAllDrivers'.
  128.  
  129. MikMod_InfoLoader
  130. .................
  131.  
  132.    `CHAR* MikMod_InfoLoader(void)'
  133. Description
  134.      This function returns a formatted list of the registered module
  135.      loaders in a buffer.
  136.  
  137. Result
  138.      A pointer to a text buffer, or `NULL' if no loaders are registered.
  139.  
  140. Notes
  141.      The buffer is created with `malloc'; the caller must free it when
  142.      it is no longer necessary.
  143.  
  144. See also
  145.      `MikMod_RegisterLoader', `MikMod_RegisterAllLoaders'.
  146.  
  147. MikMod_Init
  148. ...........
  149.  
  150.    `BOOL MikMod_Init(void)'
  151. Description
  152.      This function performs the library initialization, including the
  153.      sound driver choice and configuration, and all the necessary
  154.      memory allocations.
  155.  
  156. Result
  157. 0
  158.      Initialization was successful.
  159.  
  160. nonzero
  161.      An error occurred during initialization.
  162.  
  163. Notes
  164.      When the initialization fails, the library uses the nosound sound
  165.      driver to let other the other MikMod functions work without
  166.      crashing the application.
  167.  
  168. See also
  169.      `MikMod_Exit', `MikMod_Reset'.
  170.  
  171. MikMod_RegisterAllDrivers
  172. .........................
  173.  
  174.    `void MikMod_RegisterAllDrivers(void)'
  175. Description
  176.      This function registers all the available drivers.
  177.  
  178. See also
  179.      `MikMod_InfoDriver', `MikMod_RegisterDriver'.
  180.  
  181. MikMod_RegisterAllLoaders
  182. .........................
  183.  
  184.    `void MikMod_RegisterAllLoaders(void)'
  185. Description
  186.      This function registers all the available module loaders.
  187.  
  188. See also
  189.      `MikMod_InfoLoader', `MikMod_RegisterLoader'.
  190.  
  191. MikMod_RegisterDriver
  192. .....................
  193.  
  194.    `void MikMod_RegisterDriver(struct MDRIVER* newdriver)'
  195. Description
  196.      This function adds the specified driver to the internal list of
  197.      usable drivers.
  198.  
  199. Parameters
  200. newdriver
  201.      A pointer to the `MDRIVER' structure identifying the driver.
  202.  
  203. Notes
  204.      It is safe to register the same driver several times, although it
  205.      will not be duplicated in the list.
  206.      You should register all the drivers you need before calling
  207.      `MikMod_Init'.  If you want to register all the available drivers,
  208.      use `MikMod_RegisterAllDrivers' instead.
  209.  
  210. See also
  211.      `MikMod_InfoDriver', `MikMod_RegisterAllDrivers'.
  212.  
  213. MikMod_RegisterErrorHandler
  214. ...........................
  215.  
  216.    `MikMod_handler_t MikMod_RegisterErrorHandler(MikMod_handler_t
  217. newhandler)'
  218. Description
  219.      This function selects the function which should be called in case
  220.      of error.
  221.  
  222. Parameters
  223. newhandler
  224.      The new error callback function.
  225.  
  226. Result
  227.      The previous error callback function, or `NULL' if there was none.
  228.  
  229. Notes
  230.      `MikMod_handler_t' is defined as `void(*function)(void)', this
  231.      means your error function has the following prototype: `void
  232.      MyErrorHandler(void)'
  233.      The error callback function is called when errors are detected,
  234.      but not always immediately (the library has to resume to a stable
  235.      state before calling your callback).
  236.  
  237. MikMod_RegisterLoader
  238. .....................
  239.  
  240.    `void MikMod_RegisterLoader(struct MLOADER* newloader)'
  241. Description
  242.      This function adds the specified module loader to the internal
  243.      list of usable module loaders.
  244.  
  245. Parameters
  246. newloader
  247.      A pointer to the `MLOADER' structure identifying the loader.
  248.  
  249. Notes
  250.      It is safe to register the same loader several times, although it
  251.      will not be duplicated in the list.
  252.      You should register all the loaders you need before calling
  253.      `Player_Load' or `Player_LoadFP'. If you want to register all the
  254.      available module loaders, use `MikMod_RegisterAllLoaders' instead.
  255.      The 15 instrument module loader (`load_m15') should always be
  256.      registered last.
  257.  
  258. See also
  259.      `MikMod_InfoLoader', `MikMod_RegisterAllLoaders'.
  260.  
  261. MikMod_RegisterPlayer
  262. .....................
  263.  
  264.    `MikMod_player_t MikMod_RegisterPlayer(MikMod_player_t newplayer)'
  265. Description
  266.      This function selects the function which should be used to process
  267.      module playback.
  268.  
  269. Parameters
  270. newplayer
  271.      The new playback function
  272.  
  273. Result
  274.      The previous playback function.
  275.  
  276. Notes
  277.      `MikMod_player_t' is defined as `void(*function)(void)', this means
  278.      your player function has the following prototype: `void
  279.      MyPlayer(void)'
  280.      The player function is called every module tick to process module
  281.      playback.  The rate at which the player function is called is
  282.      controlled by the sound driver, and is computed by the following
  283.      equation:
  284.      (bpm*50)/125 calls per second, which means every 125000/(bpm*50)
  285.      milliseconds. The `bpm' value is the tempo of the module and can
  286.      change from its initial value when requested by the module.
  287.      When changing the playback function, you should make sure that you
  288.      chain to the default MikMod playback function, otherwise you won't
  289.      get module sound anymore....
  290.  
  291. Example
  292.               MikMod_player_t oldroutine;
  293.           
  294.               void MyPlayer(void)
  295.               {
  296.                   oldroutine();
  297.                   /* your stuff here */
  298.                   ...;
  299.               }
  300.           
  301.               main()
  302.               {
  303.                   ...
  304.                   /* Register our player */
  305.                   oldroutine=MikMod_RegisterPlayer(MyPlayer);
  306.                   ...
  307.               }
  308.  
  309. MikMod_Reset
  310. ............
  311.  
  312.    `BOOL MikMod_Reset(void)'
  313. Description
  314.      This function resets MikMod and reinitialize the sound hardware.
  315.  
  316. Result
  317. 0
  318.      Reinitialization was successful.
  319.  
  320. nonzero
  321.      An error occurred during reinitialization.
  322.  
  323. Notes
  324.      Use this function when you have changed the global configuration
  325.      variables: `md_device' and `md_mixfreq', or one of the `md_mode'
  326.      flags which require sound reinitialization. Sound playback will
  327.      continue as soon as the driver is ready.
  328.  
  329. See also
  330.      `MikMod_Exit', `MikMod_Init'.
  331.  
  332. MikMod_SetNumVoices
  333. ...................
  334.  
  335.    `BOOL MikMod_SetNumVoices(int musicvoices,int samplevoices)'
  336. Description
  337.      This function sets the number of mixed voices which can be used
  338.      for music and sound effects playback.
  339.  
  340. Parameters
  341. musicvoices
  342.      The number of voices to reserve for music playback.
  343.  
  344. samplevoices
  345.      The number of voices to reserve for sound effects.
  346.  
  347. Result
  348. 0
  349.      Initialization was successful.
  350.  
  351. nonzero
  352.      An error occurred during initialization.
  353.  
  354. Notes
  355.      A value of `-1' for any of the parameters will retain the current
  356.      number of reserved voices.
  357.      The maximum number of voices vary from driver to driver (hardware
  358.      drivers often have a limit of 32 to 64 voices, whereas the
  359.      software drivers handle 255 voices). If your settings exceed the
  360.      driver's limit, they will be truncated.
  361.  
  362. See also
  363.      `MikMod_Init', `MikMod_Reset'.
  364.  
  365. MikMod_Update
  366. .............
  367.  
  368.    `void MikMod_Update(void)'
  369. Description
  370.      This routine should be called on a regular basis to update the
  371.      sound.
  372.  
  373. Notes
  374.      The sound output buffer is filled each time this function is
  375.      called; if you use a large buffer, you don't need to call this
  376.      routine as frequently as with a smaller buffer, but you get a
  377.      bigger shift between the sound being played and the reported state
  378.      of the player, since the player is always a buffer ahead of the
  379.      playback.
  380.      If you play low quality sound (for example, mono 8 bit 11kHz
  381.      sound), you only need to call this routine a few times per second.
  382.      However, for high quality sound (stereo 16 bit 44kHz), this rate
  383.      increases to a few hundred times per second, but never more, due
  384.      to the minimal buffer size constraint imposed to the sound drivers.
  385.      If you plan on modifying voice information with the `Voice_xx'
  386.      functions, you should do this before calling `MikMod_Update'.
  387.  
  388. MikMod_strerror
  389. ...............
  390.  
  391.    `char* MikMod_strerror(int errno)'
  392. Description
  393.      This function associates a descriptive message to an error code.
  394.  
  395. Parameters
  396. errno
  397.      The MikMod error code.
  398.  
  399. Result
  400.      A pointer to a string describing the error.
  401.  
  402. 
  403. File: mikmod.info,  Node: Module Player Functions,  Next: Sample Functions,  Prev: Library Core Functions,  Up: Function Reference
  404.  
  405. Module Player Functions
  406. -----------------------
  407.  
  408. Player_Active
  409. .............
  410.  
  411.    `BOOL Player_Active(void)'
  412. Description
  413.      This function returns whether the module player is active or not.
  414.  
  415. Result
  416. 0
  417.      No module is playing.
  418.  
  419. nonzero
  420.      A module is currently playing.
  421.  
  422. Notes
  423.      This function will still report that the player is active if the
  424.      playing module is paused.
  425.  
  426. See also
  427.      `Player_Paused', `Player_TogglePause', `Player_Start',
  428.      `Player_Stop'
  429.  
  430. Player_Free
  431. ...........
  432.  
  433.    `void Player_Free(MODULE* module)'
  434. Description
  435.      This function stops the module if it is playing and unloads it
  436.      from memory.
  437.  
  438. Parameters
  439. module
  440.      The module to free.
  441.  
  442. See also
  443.      `Player_Load', `Player_LoadFP'.
  444.  
  445. Player_GetChannelVoice
  446. ......................
  447.  
  448.    `int Player_GetChannelVoice(int channel)'
  449. Description
  450.      This function determines the voice corresponding to the specified
  451.      module channel.
  452.  
  453. Parameters
  454. channel
  455.      The module channel to use.
  456.  
  457. Result
  458.      The number of the voice corresponding to the module channel.
  459.  
  460. Notes
  461.      If the module channel has NNAs, the number will correspond to the
  462.      main channel voice.
  463.  
  464. See also
  465.      `Voice_SetPanning', `Voice_SetVolume', `Player_Mute',
  466.      `Player_ToggleMute', `Player_Unmute'.
  467.  
  468. Player_GetModule
  469. ................
  470.  
  471.    `MODULE* Player_GetModule(void)'
  472. Description
  473.      This function returns the module currently being played.
  474.  
  475. Result
  476.      A pointer to the `MODULE' being played, or `NULL' if no module is
  477.      playing.
  478.  
  479. See also
  480.      `Player_Stop', `Player_Start'.
  481.  
  482. Player_Load
  483. ...........
  484.  
  485.    `MODULE* Player_Load(CHAR* filename,int maxchan,BOOL curious)'
  486. Description
  487.      This function loads a music module.
  488.  
  489. Parameters
  490. filename
  491.      The name of the module file.
  492.  
  493. maxchan
  494.      The maximum number of channels the song is allowed to request from
  495.      the mixer.
  496.  
  497. curious
  498.      The curiosity level to use.
  499.  
  500. Result
  501.      A pointer to a `MODULE' structure, or `NULL' if an error occurs.
  502.  
  503. Notes
  504.      If the curiosity level is set to zero, the module will be loaded
  505.      normally.  However, if it is nonzero, the following things occur:
  506.         * pattern positions occurring after the "end of song" marker in
  507.           S3M and IT modules are loaded, and the end of song is set to
  508.           the last position.
  509.  
  510.         * hidden extra patterns are searched in MOD modules, and if
  511.           found, played after the last "official" pattern.
  512.  
  513.         * MED modules with synthsounds are loaded without causing the
  514.           `MMERR_MED_SYNTHSAMPLES', and synthsounds are mapped to an
  515.           empty sample.
  516.  
  517. See also
  518.      `Player_Free', `Player_LoadFP', `Player_LoadTitle', `Player_Start'.
  519.  
  520. Player_LoadFP
  521. .............
  522.  
  523.    `MODULE* Player_LoadFP(FILE* file,int maxchan,BOOL curious)'
  524. Description
  525.      This function loads a music module.
  526.  
  527. Parameters
  528. file
  529.      An open file, at the position where the module starts.
  530.  
  531. maxchan
  532.      The maximum number of channels the song is allowed to request from
  533.      the mixer.
  534.  
  535. curious
  536.      The curiosity level to use.
  537.  
  538. Result
  539.      A pointer to a `MODULE' structure, or `NULL' if an error occurs.
  540.  
  541. Notes
  542.      The file is left open, at the same position as before the function
  543.      call.
  544.      If the curiosity level is set to zero, the module will be loaded
  545.      normally.  However, if it is nonzero, the following things occur:
  546.         * pattern positions occurring after the "end of song" marker in
  547.           S3M and IT modules are loaded, and the end of song is set to
  548.           the last position.
  549.  
  550.         * hidden extra patterns are searched in MOD modules, and if
  551.           found, played after the last "official" pattern.
  552.  
  553.         * MED modules with synthsounds are loaded without causing the
  554.           `MMERR_MED_SYNTHSAMPLES', and synthsounds are mapped to an
  555.           empty sample.
  556.  
  557. See also
  558.      `Player_Free', `Player_Load', `Player_LoadTitle', `Player_Start'.
  559.  
  560. Player_LoadTitle
  561. ................
  562.  
  563.    `MODULE* Player_LoadTitle(CHAR* filename)'
  564. Description
  565.      This function retrieves the title of a module file.
  566.  
  567. Parameters
  568. filename
  569.      The name of the module file.
  570.  
  571. Result
  572.      A pointer to the song title, or `NULL' if either the module has no
  573.      title or an error has occurred.
  574.  
  575. Notes
  576.      The title buffer is created with `malloc'; the caller must free it
  577.      when it is no longer necessary.
  578.  
  579. See also
  580.      `Player_Load', `Player_LoadFP'.
  581.  
  582. Player_Mute
  583. ...........
  584.  
  585.    `void Player_Mute(SLONG operation,...)'
  586. Description
  587.      This function mutes a single module channel, or a range of module
  588.      channels.
  589.  
  590. Parameters
  591. operation
  592.      Either the number of a module channel to mute (starting from
  593.      zero), or an operation code. In the latter case, two extra
  594.      parameters are needed to determine the range of channels.
  595.  
  596. Notes
  597.      If the operation is `MUTE_INCLUSIVE', the two channel numbers
  598.      delimit the range and are part of the range ; otherwise, if the
  599.      operation is `MUTE_EXCLUSIVE', they are outside of the range.
  600.  
  601. Example
  602.               /* mute channel 10 */
  603.               Player_Mute(10);
  604.               /* mute channels 2 to 5 */
  605.               Player_Mute(MUTE_INCLUSIVE,2,5);
  606.               /* mute channels 7 to 9 */
  607.               Player_Mute(MUTE_EXCLUSIVE,6,10);
  608.  
  609. See also
  610.      `Player_Muted', `Player_ToggleMute', `Player_Unmute'.
  611.  
  612. Player_Muted
  613. ............
  614.  
  615.    `BOOL Player_Muted(UBYTE channel)'
  616. Description
  617.      This function determines whether a module channel is muted or not.
  618.  
  619. Parameters
  620. channel
  621.      The module channel to test (starting from zero).
  622.  
  623. Result
  624. 0
  625.      The channel is not muted.
  626.  
  627. 1
  628.      The channel is muted.
  629.  
  630. See also
  631.      `Player_Mute', `Player_ToggleMute', `Player_Unmute'.
  632.  
  633. Player_NextPosition
  634. ...................
  635.  
  636.    `void Player_NextPosition(void)'
  637. Description
  638.      This function jumps to the next position in the module.
  639.  
  640. Notes
  641.      All playing samples and active song voices are cut to avoid
  642.      hanging notes.
  643.  
  644. See also
  645.      `Player_PrevPosition', `Player_SetPosition'.
  646.  
  647. Player_Paused
  648. .............
  649.  
  650.    `BOOL Player_Paused(void)'
  651. Description
  652.      This function determines whether the module is paused or not.
  653.  
  654. Result
  655. 0
  656.      The module is not paused.
  657.  
  658. 1
  659.      The module is paused.
  660.  
  661. See also
  662.      `Player_TogglePause'.
  663.  
  664. Player_PrevPosition
  665. ...................
  666.  
  667.    `void Player_PrevPosition(void)'
  668. Description
  669.      This function jumps to the previous position in the module.
  670.  
  671. Notes
  672.      All playing samples and active song voices are cut to avoid
  673.      hanging notes.
  674.  
  675. See also
  676.      `Player_NextPosition', `Player_SetPosition'.
  677.  
  678. Player_SetPosition
  679. ..................
  680.  
  681.    `void Player_SetPosition(UWORD position)'
  682. Description
  683.      This function jumps to the specified position in the module.
  684.  
  685. Parameters
  686. position
  687.      The pattern position to jump to.
  688.  
  689. Notes
  690.      All playing samples and active song voices are cut to avoid
  691.      hanging notes.
  692.  
  693. See also
  694.      `Player_NextPosition', `Player_PrevPosition'.
  695.  
  696. Player_SetSpeed
  697. ...............
  698.  
  699.    `void Player_SetSpeed(UWORD speed)'
  700. Description
  701.      This function sets the module speed.
  702.  
  703. Parameters
  704. speed
  705.      The new module speed, in the range 1-32.
  706.  
  707. See also
  708.      `Player_SetTempo'.
  709.  
  710. Player_SetTempo
  711. ...............
  712.  
  713.    `void Player_SetTempo(UWORD tempo)'
  714. Description
  715.      This function sets the module tempo.
  716.  
  717. Parameters
  718. tempo
  719.      The new module tempo, in the range 32-255.
  720.  
  721. See also
  722.      `Player_SetSpeed'.
  723.  
  724. Player_SetVolume
  725. ................
  726.  
  727.    `void Player_SetVolume(SWORD volume)'
  728. Description
  729.      This function sets the module volume.
  730.  
  731. Parameters
  732. volume
  733.      The new overall module playback volume, in the range 0-128.
  734.  
  735. Player_Start
  736. ............
  737.  
  738.    `void Player_Start(MODULE* module)'
  739. Description
  740.      This function starts the specified module playback.
  741.  
  742. Parameters
  743. module
  744.      The module to play.
  745.  
  746. Notes
  747.      If another module is playing, it will be stopped and the new
  748.      module will play.
  749.  
  750. See also
  751.      `Player_Stop'.
  752.  
  753. Player_Stop
  754. ...........
  755.  
  756.    `void Player_Stop(void)'
  757. Description
  758.      This function stops the currently playing module.
  759.  
  760. See also
  761.      `Player_Start'.
  762.  
  763. Player_ToggleMute
  764. .................
  765.  
  766.    `void Player_ToggleMute(SLONG operation,...)'
  767. Description
  768.      This function changes the muted status of a single module channel,
  769.      or a range of module channels.
  770.  
  771. Parameters
  772. operation
  773.      Either the number of a module channel to work on (starting from
  774.      zero), or an operation code. In the latter case, two extra
  775.      parameters are needed to determine the range of channels.
  776.  
  777. Notes
  778.      If the operation is `MUTE_INCLUSIVE', the two channel numbers
  779.      delimit the range and are part of the range ; otherwise, if the
  780.      operation is `MUTE_EXCLUSIVE', they are outside of the range.
  781.  
  782. Example
  783.               /* toggle mute on channel 10 */
  784.               Player_ToggleMute(10);
  785.               /* toggle mute on channels 2 to 5 */
  786.               Player_ToggleMute(MUTE_INCLUSIVE,2,5);
  787.               /* toggle mute on channels 7 to 9 */
  788.               Player_ToggleMute(MUTE_EXCLUSIVE,6,10);
  789.  
  790. See also
  791.      `Player_Mute', `Player_Muted', `Player_Unmute'.
  792.  
  793. Player_TogglePause
  794. ..................
  795.  
  796.    `void Player_TogglePause(void)'
  797. Description
  798.      This function toggles the playing/paused status of the module.
  799.  
  800. Notes
  801.      Calls to `Player_xx' functions still have effect when the module
  802.      is paused.
  803.  
  804. See also
  805.      `Player_Paused', `Player_Start', `Player_Stop'.
  806.  
  807. Player_Unmute
  808. .............
  809.  
  810.    `void Player_Unmute(SLONG operation,...)'
  811. Description
  812.      This function unmutes a single module channel, or a range of
  813.      module channels.
  814.  
  815. Parameters
  816. operation
  817.      Either the number of a module channel to unmute (starting from
  818.      zero), or an operation code. In the latter case, two extra
  819.      parameters are needed to determine the range of channels.
  820.  
  821. Notes
  822.      If the operation is `MUTE_INCLUSIVE', the two channel numbers
  823.      delimit the range and are part of the range ; otherwise, if the
  824.      operation is `MUTE_EXCLUSIVE', they are outside of the range.
  825.  
  826. Example
  827.               /* unmute channel 10 */
  828.               Player_Unmute(10);
  829.               /* unmute channels 2 to 5 */
  830.               Player_Unmute(MUTE_INCLUSIVE,2,5);
  831.               /* unmute channels 7 to 9 */
  832.               Player_Unmute(MUTE_EXCLUSIVE,6,10);
  833.  
  834. See also
  835.      `Player_Mute', `Player_Muted', `Player_ToggleMute'.
  836.  
  837. 
  838. File: mikmod.info,  Node: Sample Functions,  Next: Voice Functions,  Prev: Module Player Functions,  Up: Function Reference
  839.  
  840. Sample Functions
  841. ----------------
  842.  
  843. Sample_Free
  844. ...........
  845.  
  846.    `void Sample_Free(SAMPLE* sample)'
  847. Description
  848.      This function unloads a sample from memory.
  849.  
  850. Parameters
  851. sample
  852.      The sample to free.
  853.  
  854. See also
  855.      `Sample_Load', `Sample_LoadFP'.
  856.  
  857. Sample_Load
  858. ...........
  859.  
  860.    `SAMPLE* Sample_Load(CHAR* filename)'
  861. Description
  862.      This function loads a sample.
  863.  
  864. Parameters
  865. filename
  866.      The sample filename.
  867.  
  868. Result
  869.      A pointer to a `SAMPLE' structure, or `NULL' if an error has
  870.      occurred.
  871.  
  872. See also
  873.      `Sample_Free', `Sample_LoadFP'.
  874.  
  875. Sample_LoadFP
  876. .............
  877.  
  878.    `SAMPLE* Sample_LoadFP(FILE* file)'
  879. Description
  880.      This function loads a sample.
  881.  
  882. Parameters
  883. file
  884.      An open file, at the position where the sample starts.
  885.  
  886. Result
  887.      A pointer to a `SAMPLE' structure, or `NULL' if an error has
  888.      occurred.
  889.  
  890. Notes
  891.      The file is left open, at the same position as before the function
  892.      call.
  893.  
  894. See also
  895.      `Sample_Free', `Sample_Load'.
  896.  
  897. Sample_Play
  898. ...........
  899.  
  900.    `SBYTE Sample_Play(SAMPLE* sample,ULONG start,UBYTE flags)'
  901. Description
  902.      This function plays a sample as a sound effect.
  903.  
  904. Parameters
  905. sample
  906.      The sample to play.
  907.  
  908. start
  909.      The starting position (in samples).
  910.  
  911. flags
  912.      Either zero, for normal sound effects, or `SFX_CRITICAL', for
  913.      critical sound effects which must not be interrupted.
  914.  
  915. Result
  916.      The voice number corresponding to the voice which will play the
  917.      sample.
  918.  
  919. Notes
  920.      Each new sound effect is played on a new voice. When all voices
  921.      are taken, the oldest sample which was not marked as critical is
  922.      cut and its voice is used for the new sample. Critical samples are
  923.      not cut unless all the voices are taken with critical samples and
  924.      you attempt to play yet another critical sample. Use `Voice_Stop'
  925.      to force the end of a critical sample.
  926.  
  927. See also
  928.      `MikMod_SetNumVoices', `Voice_Play', `Voice_SetFrequency',
  929.      `Voice_SetPanning', `Voice_SetVolume', `Voice_Stop'.
  930.  
  931. 
  932. File: mikmod.info,  Node: Voice Functions,  Next: Loader Reference,  Prev: Sample Functions,  Up: Function Reference
  933.  
  934. Voice Functions
  935. ---------------
  936.  
  937. Voice_GetPosition
  938. .................
  939.  
  940.    `SLONG Voice_GetPosition(SBYTE voice)'
  941. Description
  942.      This function returns the sample position (in samples) of the
  943.      sample currently playing on the specified voice.
  944.  
  945. Parameters
  946. voice
  947.      The number of the voice to get sample position (starting from
  948.      zero).
  949.  
  950. Result
  951.      The current play location of the sample playing on the specified
  952.      voice, or zero if the position can not be determined or if no
  953.      sample is currently playing on the voice.
  954.  
  955. Notes
  956.      This function may not work with some drivers (especially for
  957.      hardware mixed voices). In this case, it returns always zero.
  958.  
  959. See also
  960.      `Sample_Play', `Voice_Play'.
  961.  
  962. Voice_Play
  963. ..........
  964.  
  965.    `void Voice_Play(SBYTE voice,SAMPLE* sample,ULONG start)'
  966. Description
  967.      Start a new sample in the specified voice.
  968.  
  969. Parameters
  970. voice
  971.      The number of the voice to be processed (starting from zero).
  972.  
  973. sample
  974.      The sample to play.
  975.  
  976. start
  977.      The starting position (in samples).
  978.  
  979. Notes
  980.      The sample will be played at the volume, panning and frequency
  981.      settings of the voice, regardless or the sample characteristics.
  982.      The sample played this way gets the same "critical" status as the
  983.      sample which was previously played on this voice.
  984.  
  985. See also
  986.      `Sample_Play', `Voice_SetFrequency', `Voice_SetPanning',
  987.      `Voice_SetVolume'.
  988.  
  989. Voice_RealVolume
  990. ................
  991.  
  992.    `ULONG Voice_RealVolume(SBYTE voice)'
  993. Description
  994.      This function returns the actual playing volume of the specified
  995.      voice.
  996.  
  997. Parameters
  998. voice
  999.      The number of the voice to analyze (starting from zero).
  1000.  
  1001. Result
  1002.      The real volume of the voice when the function was called, in the
  1003.      range 0-65535, not related to the volume constraint specified with
  1004.      `Voice_SetVolume'.
  1005.  
  1006. Notes
  1007.      This function may not work with some drivers (especially for
  1008.      hardware mixed voices). In this case, it returns always zero.
  1009.      Also note that the real volume computation is not a trivial
  1010.      process and takes some CPU time.
  1011.  
  1012. See also
  1013.      `Sample_Play', `Voice_Play', `Voice_SetVolume'.
  1014.  
  1015. Voice_SetFrequency
  1016. ..................
  1017.  
  1018.    `void Voice_SetFrequency(SBYTE voice,ULONG frequency)'
  1019. Description
  1020.      This function sets the frequency (pitch) of the specified voice.
  1021.  
  1022. Parameters
  1023. voice
  1024.      The number of the voice to be processed (starting from zero).
  1025.  
  1026. frequency
  1027.      The new frequency of the voice, in hertz.
  1028.  
  1029. See also
  1030.      `Sample_Play', `Voice_Play', `Voice_SetPanning',
  1031.      `Voice_SetVolume', `Voice_Stop'.
  1032.  
  1033. Voice_SetPanning
  1034. ................
  1035.  
  1036.    `void Voice_SetPanning(SBYTE voice,ULONG panning)'
  1037. Description
  1038.      This function sets the panning position of the specified voice.
  1039.  
  1040. Parameters
  1041. voice
  1042.      The number of the voice to be processed (starting from zero).
  1043.  
  1044. panning
  1045.      The new panning position of the voice.
  1046.  
  1047. Notes
  1048.      Panning can vary between 0 (`PAN_LEFT') and 255 (`PAN_RIGHT').
  1049.      Center is 127 (`PAN_CENTER'. Surround sound can be enabled by
  1050.      specifying the special value `PAN_SURROUND'.
  1051.  
  1052. See also
  1053.      `Sample_Play', `Voice_Play', `Voice_SetFrequency',
  1054.      `Voice_SetVolume', `Voice_Stop'.
  1055.  
  1056. Voice_SetVolume
  1057. ...............
  1058.  
  1059.    `void Voice_SetVolume(SBYTE voice,UWORD volume)'
  1060. Description
  1061.      This function sets the volume of the specified voice.
  1062.  
  1063. Parameters
  1064. voice
  1065.      The number of the voice to be processed (starting from zero).
  1066.  
  1067. volume
  1068.      The new volume of the voice, in the range 0-256.
  1069.  
  1070. See also
  1071.      `Sample_Play', `Voice_Play', `Voice_SetFrequency',
  1072.      `Voice_SetPanning', `Voice_Stop'.
  1073.  
  1074. Voice_Stop
  1075. ..........
  1076.  
  1077.    `void Voice_Stop(SBYTE voice)'
  1078. Description
  1079.      This function stops the playing sample of the specified voice.
  1080.  
  1081. Parameters
  1082. voice
  1083.      The number of the voice to be processed (starting from zero).
  1084.  
  1085. Notes
  1086.      After the call to `Voice_Stop', the function `Voice_Stopped' will
  1087.      return nonzero (true) for the voice. If you want to silence the
  1088.      voice without stopping the playback, use
  1089.      `Voice_SetVolume(voice,0)' instead.
  1090.  
  1091. See also
  1092.      `Sample_Play', `Voice_Play', `Voice_SetFrequency',
  1093.      `Voice_SetPanning', `Voice_SetVolume'.
  1094.  
  1095. Voice_Stopped
  1096. .............
  1097.  
  1098.    `BOOL Voice_Stopped(SBYTE voice)'
  1099. Description
  1100.      This function returns whether the voice is active or not.
  1101.  
  1102. Parameters
  1103. voice
  1104.      The number of the voice to be checked (starting from zero).
  1105.  
  1106. Result
  1107. 0
  1108.      The voice is stopped or has no sample assigned.
  1109.  
  1110. nonzero
  1111.      The voice is playing a sample.
  1112.  
  1113. See also
  1114.      `Voice_Stop'.
  1115.  
  1116. 
  1117. File: mikmod.info,  Node: Loader Reference,  Next: Module Loaders,  Prev: Voice Functions,  Up: Library Reference
  1118.  
  1119. Loader Reference
  1120. ================
  1121.  
  1122. * Menu:
  1123.  
  1124. * Module Loaders::
  1125. * Sample Loaders::
  1126.  
  1127. 
  1128. File: mikmod.info,  Node: Module Loaders,  Next: Sample Loaders,  Prev: Loader Reference,  Up: Loader Reference
  1129.  
  1130. Module Loaders
  1131. --------------
  1132.  
  1133.    MikMod presents a large choice of module loaders, for the most
  1134. common formats as well as for some less-known exotic formats.
  1135.  
  1136. `load_669'
  1137.      This loader recognizes "Composer 669" and "Unis 669" modules. The
  1138.      669 and "Extended 669" formats were among the first PC module
  1139.      formats. They do not have a wide range of effects, but support up
  1140.      to 32 channels.
  1141.      "Composer 669" was written by Tran of Renaissance, a.k.a. Tomasz
  1142.      Pytel and released in 1992. "Unis 669 Composer" was written by
  1143.      Jason Nunn and released in 1994.
  1144.  
  1145. `load_amf'
  1146.      This loader recognizes the "Advanced Module Format", which is the
  1147.      internal module format of the "DOS Sound and Music Interface"
  1148.      (DSMI) library. This format has the same limitations as the S3M
  1149.      format. The most famous DSMI application was DMP, the Dual Module
  1150.      Player.
  1151.      DMP and the DSMI library were written by Otto Chrons. DSMI was
  1152.      first released in 1993.
  1153.  
  1154. `load_dsm'
  1155.      This loader recognizes the internal DSIK format, which is the
  1156.      internal module format of the "Digital Sound Interface Kit" (DSIK)
  1157.      library, the ancester of the SEAL library. This format has the
  1158.      same limitations as the S3M format.
  1159.      The DSIK library was written by Carlos Hasan and released in 1994.
  1160.  
  1161. `load_far'
  1162.      This loader recognizes "Farandole" modules. These modules can be
  1163.      up to 16 channels and have Protracker comparable effects. The
  1164.      Farandole composer was written by Daniel Potter and released in
  1165.      1994.
  1166.  
  1167. `load_it'
  1168.      This loader recognizes "Impulse Tracker" modules, currently the
  1169.      most powerful format. These modules support up to 64 real
  1170.      channels, and up to 256 virtual channels with the "New Note
  1171.      Action" feature. Besides, it has the widest range of effects, and
  1172.      supports 16 bit samples as well as surround sound.
  1173.      "Impulse Tracker" was written by Jeffrey Lim and released in 1996.
  1174.  
  1175. `load_med'
  1176.      This loader recognizes "OctaMED" modules. These modules are
  1177.      comparable to Protracker modules, but can embed "synthsounds",
  1178.      which are midi-like instruments.
  1179.      "MED" and later "OctaMED" were written by Teijo Kinnunen. "MED" was
  1180.      released in 1989, and "OctaMED" was released in 1992.
  1181.  
  1182. `load_m15'
  1183.      This loader recognizes the old 15 instrument modules, created by
  1184.      "Ultimate Soundtracker", "Soundtracker" and the first versions of
  1185.      "Protracker".
  1186.      Since this format was one of the first module formats, developed
  1187.      in 1987, it does not have any signature field, which makes it hard
  1188.      to detect reliably, because of its similarities with later module
  1189.      formats.
  1190.  
  1191. `load_mod'
  1192.      This loader recognizes the standard 31 instrument modules, created
  1193.      by "Protracker" or Protracker-compatible programs. The original
  1194.      Protracker format was limited to 4 channels, but other trackers
  1195.      like "TakeTracker", "StarTracker" or "Oktalyzer" afforded more
  1196.      channels.
  1197.      Although it is now technically obsolete, this format is still
  1198.      widely used, due to its playback simplicity (on the adequate
  1199.      hardware, the Amiga).
  1200.  
  1201. `load_mtm'
  1202.      This loader recognizes the "MultiTracker Module Editor" modules.
  1203.      The MTM format has up to 32 channels, and protracker comparable
  1204.      effects. It was intended to replace "Composer 669".  The
  1205.      "MultiTracker Module Editor" was written by Starscream of
  1206.      Renaissance, a.k.a. Daniel Goldstein and released in late 1993.
  1207.  
  1208. `load_stm'
  1209.      This loader recognizes "ScreamTracker" modules. "ScreamTracker"
  1210.      was the first PC tracker, as well as the first PC module format.
  1211.      Loosely inspired by the "SoundTracker" format, it does not have as
  1212.      many effects as Protracker, although it supports 31 instruments
  1213.      and 4 channels.
  1214.      "ScreamTracker" was written by PSI of Future Crew, a.k.a. Sami
  1215.      Tammilehto.
  1216.  
  1217. `load_s3m'
  1218.      This loader recognizes "ScreamTracker 3" modules. This version was
  1219.      a huge improvement over the original "ScreamTracker". It supported
  1220.      32 channels (although the tracker only let you work on 16), up to
  1221.      99 instruments, and a large choice of effects.
  1222.      "ScreamTracker 3" was written by PSI of Future Crew, a.k.a. Sami
  1223.      Tammilehto, and released in 1994.
  1224.  
  1225. `load_ult'
  1226.      This loader recognizes "UltraTracker" modules. They are mostly
  1227.      similar to Protracker modules, but support two effects per channel.
  1228.      "UltraTracker" was written by MAS of Prophecy, a.k.a. Marc Andre
  1229.      Schallehn, and released in 1993.
  1230.  
  1231. `load_xm'
  1232.      This loader recognizes "FastTracker 2" modules. This format was
  1233.      designed from scratch, instead of creating yet another Protracker
  1234.      variation. It was the first format using instruments as well as
  1235.      samples, and envelopes for finer effects.
  1236.      FastTracker 2 was written by Fredrik Huss and Magnus Hogdahl, and
  1237.      released in 1994.
  1238.  
  1239. 
  1240. File: mikmod.info,  Node: Sample Loaders,  Next: Driver Reference,  Prev: Module Loaders,  Up: Loader Reference
  1241.  
  1242. Sample Loaders
  1243. --------------
  1244.  
  1245.    Currently, the only file type than can be loaded as a sample is the
  1246. RIFF WAVE file. Stereo or compressed WAVE files are not supported yet.
  1247.  
  1248. 
  1249. File: mikmod.info,  Node: Driver Reference,  Next: Network Drivers,  Prev: Sample Loaders,  Up: Library Reference
  1250.  
  1251. Driver Reference
  1252. ================
  1253.  
  1254. * Menu:
  1255.  
  1256. * Network Drivers::
  1257. * Hardware Drivers::
  1258. * Disk Writer Drivers::
  1259. * Other Drivers::
  1260.  
  1261. 
  1262. File: mikmod.info,  Node: Network Drivers,  Next: Hardware Drivers,  Prev: Driver Reference,  Up: Driver Reference
  1263.  
  1264. Network Drivers
  1265. ---------------
  1266.  
  1267.    These drivers send the generated sound over the network to a server
  1268. program, which sends the sound to the real sound hardware. The server
  1269. program can be on the same machine than your program, but MikMod does
  1270. not have access to the hardware. Network drivers only support software
  1271. mixing.
  1272.  
  1273. `drv_AF'
  1274.      This driver works with the "Digital AudioFile" library.
  1275.      Start the server on the machine you want, set its hostname in the
  1276.      `AUDIOFILE' environment variable, and MikMod is ready to send it
  1277.      sound.
  1278.  
  1279. `drv_esd'
  1280.      This driver works with the "Enlightened Sound Daemon".
  1281.      Start the esd daemon on the machine you want, set its hostname in
  1282.      the `ESPEAKER' environment variable, and MikMod is ready to send
  1283.      it sound.
  1284.  
  1285. 
  1286. File: mikmod.info,  Node: Hardware Drivers,  Next: Disk Writer Drivers,  Prev: Network Drivers,  Up: Driver Reference
  1287.  
  1288. Hardware Drivers
  1289. ----------------
  1290.  
  1291.    These drivers access to the sound hardware of the machine they run
  1292. on.  Depending on your Unix flavor, you'll end with one or more drivers
  1293. from this list:
  1294.  
  1295. `drv_aix'
  1296.      This driver is only available under AIX, and access its audio
  1297.      device.
  1298.      This driver only supports software mixing.
  1299.  
  1300. `drv_alsa'
  1301.      This driver is only available under Linux, and requires the ALSA
  1302.      driver to be compiled for your kernel version.
  1303.      This driver only supports software mixing, but a future version of
  1304.      the driver might be able to use the hardware capabilities of some
  1305.      sound cards.
  1306.  
  1307. `drv_dart'
  1308.      This driver is only available under OS/2 3 and higher (Warp), and
  1309.      uses the "Direct Audio Real-Time" interface.
  1310.      This driver only supports software mixing.
  1311.  
  1312. `drv_hp'
  1313.      This driver is only available under HP-UX, and access its audio
  1314.      device.
  1315.      This driver only supports software mixing.
  1316.  
  1317. `drv_os2l'
  1318. `drv_os2s'
  1319.      These drivers are only available under OS/2 3 and higher (Warp),
  1320.      and OS/2 2.x with MMPM/2. The first one uses a large buffer,
  1321.      whereas the second one uses a smaller buffer to keep the player
  1322.      status close to the actual sound output.
  1323.      This driver only supports software mixing.
  1324.  
  1325. `drv_oss'
  1326.      This driver is available under any Unix with the Open Sound System
  1327.      drivers installed. Linux and FreeBSD also come with the OSS/Lite
  1328.      driver (the non-commercial version of OSS) and can make use of
  1329.      this driver.
  1330.      This driver only supports software mixing.
  1331.  
  1332. `drv_sgi'
  1333.      This driver is only available under IRIX, and uses the SGI audio
  1334.      library.
  1335.      This driver only supports software mixing.
  1336.  
  1337. `drv_sun'
  1338.      This driver is only available under Unices which implement
  1339.      SunOS-like audio device interfaces, that is, SunOS, Solaris,
  1340.      NetBSD and OpenBSD.
  1341.      This driver only supports software mixing.
  1342.  
  1343. 
  1344. File: mikmod.info,  Node: Disk Writer Drivers,  Next: Other Drivers,  Prev: Hardware Drivers,  Up: Driver Reference
  1345.  
  1346. Disk Writer Drivers
  1347. -------------------
  1348.  
  1349.    These drivers work on any machine, since the generated sound is not
  1350. sent to hardware, but written in a file. Disk writer drivers only
  1351. support software mixing.
  1352.  
  1353. `drv_raw'
  1354.      This driver outputs the sound date in a file named `music.raw' in
  1355.      the current directory. The file has no header and only contains
  1356.      the sound output.
  1357.  
  1358. `drv_wav'
  1359.      This driver outputs the sound data in a RIFF WAVE file named
  1360.      `music.wav' in the current directory.
  1361.  
  1362. 
  1363. File: mikmod.info,  Node: Other Drivers,  Prev: Disk Writer Drivers,  Up: Driver Reference
  1364.  
  1365. Other Drivers
  1366. -------------
  1367.  
  1368.    These drivers are of little interest, but are handy sometimes.
  1369.  
  1370. `drv_stdout'
  1371.      This driver outputs the sound data to the program's standard
  1372.      output. To avoid inconvenience, the data will not be output if the
  1373.      standard output is a terminal, thus you have to pipe it through
  1374.      another command or to redirect it to a file.  Using this driver
  1375.      and redirecting to a file is equivalent to using the `drv_raw'
  1376.      disk writer.
  1377.      This driver only supports software mixing.
  1378.  
  1379. `drv_nos'
  1380.      This driver doesn't produce sound at all, and will work on any
  1381.      machine.
  1382.      Since it does not have to produce sound, it supports both hardware
  1383.      and software mixing, with as many hardware voices as you like.
  1384.  
  1385. 
  1386. File: mikmod.info,  Node: Index,  Next: Function Index,  Prev: Library Reference,  Up: Top
  1387.  
  1388. Index
  1389. *****
  1390.  
  1391. * Menu:
  1392.  
  1393. * Function Index::
  1394. * Type and Variable Index::
  1395.  
  1396. 
  1397. File: mikmod.info,  Node: Function Index,  Next: Type and Variable Index,  Prev: Index,  Up: Index
  1398.  
  1399. Function Index
  1400. **************
  1401.  
  1402. * Menu:
  1403.  
  1404. * MikMod_Active:                         Library Core Functions.
  1405. * MikMod_DisableOutput:                  Library Core Functions.
  1406. * MikMod_EnableOutput:                   Library Core Functions.
  1407. * MikMod_Exit:                           Library Core Functions.
  1408. * MikMod_GetVersion:                     Library Core Functions.
  1409. * MikMod_InfoDriver:                     Library Core Functions.
  1410. * MikMod_InfoLoader:                     Library Core Functions.
  1411. * MikMod_Init:                           Library Core Functions.
  1412. * MikMod_RegisterAllDrivers:             Library Core Functions.
  1413. * MikMod_RegisterAllLoaders:             Library Core Functions.
  1414. * MikMod_RegisterDriver:                 Library Core Functions.
  1415. * MikMod_RegisterErrorHandler:           Library Core Functions.
  1416. * MikMod_RegisterLoader:                 Library Core Functions.
  1417. * MikMod_RegisterPlayer:                 Library Core Functions.
  1418. * MikMod_Reset:                          Library Core Functions.
  1419. * MikMod_SetNumVoices:                   Library Core Functions.
  1420. * MikMod_strerror:                       Library Core Functions.
  1421. * MikMod_Update:                         Library Core Functions.
  1422. * Player_Active:                         Module Player Functions.
  1423. * Player_Free:                           Module Player Functions.
  1424. * Player_GetChannelVoice:                Module Player Functions.
  1425. * Player_GetModule:                      Module Player Functions.
  1426. * Player_Load:                           Module Player Functions.
  1427. * Player_LoadFP:                         Module Player Functions.
  1428. * Player_LoadTitle:                      Module Player Functions.
  1429. * Player_Mute:                           Module Player Functions.
  1430. * Player_Muted:                          Module Player Functions.
  1431. * Player_NextPosition:                   Module Player Functions.
  1432. * Player_Paused:                         Module Player Functions.
  1433. * Player_PrevPosition:                   Module Player Functions.
  1434. * Player_SetPosition:                    Module Player Functions.
  1435. * Player_SetSpeed:                       Module Player Functions.
  1436. * Player_SetTempo:                       Module Player Functions.
  1437. * Player_SetVolume:                      Module Player Functions.
  1438. * Player_Start:                          Module Player Functions.
  1439. * Player_Stop:                           Module Player Functions.
  1440. * Player_ToggleMute:                     Module Player Functions.
  1441. * Player_TogglePause:                    Module Player Functions.
  1442. * Player_Unmute:                         Module Player Functions.
  1443. * Sample_Free:                           Sample Functions.
  1444. * Sample_Load:                           Sample Functions.
  1445. * Sample_LoadFP:                         Sample Functions.
  1446. * Sample_Play:                           Sample Functions.
  1447. * Voice_GetPosition:                     Voice Functions.
  1448. * Voice_Play:                            Voice Functions.
  1449. * Voice_RealVolume:                      Voice Functions.
  1450. * Voice_SetFrequency:                    Voice Functions.
  1451. * Voice_SetPanning:                      Voice Functions.
  1452. * Voice_SetVolume:                       Voice Functions.
  1453. * Voice_Stop:                            Voice Functions.
  1454. * Voice_Stopped:                         Voice Functions.
  1455.  
  1456. 
  1457. File: mikmod.info,  Node: Type and Variable Index,  Prev: Function Index,  Up: Index
  1458.  
  1459. Type and Variable Index
  1460. ***********************
  1461.  
  1462. * Menu:
  1463.  
  1464. * INSTRUMENT:                            Structure Reference.
  1465. * md_device:                             Variable Reference.
  1466. * md_driver:                             Variable Reference.
  1467. * md_mixfreq:                            Variable Reference.
  1468. * md_mode:                               Variable Reference.
  1469. * md_musicvolume:                        Variable Reference.
  1470. * md_pansep:                             Variable Reference.
  1471. * md_reverb:                             Variable Reference.
  1472. * md_sndfxvolume:                        Variable Reference.
  1473. * md_volume:                             Variable Reference.
  1474. * MDRIVER:                               Structure Reference.
  1475. * MikMod_critical:                       Variable Reference.
  1476. * MikMod_errno:                          Variable Reference.
  1477. * MODULE:                                Structure Reference.
  1478. * SAMPLE:                                Structure Reference.
  1479.  
  1480.  
  1481.