6cc4dcbf4003406ce4cc9f948b09abd92845181c
[scilab.git] / scilab / modules / sound / help / ja_JP / wavread.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3     * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4     * Copyright (C) ????-2008 - INRIA - Scilab
5     *
6  * Copyright (C) 2012 - 2016 - Scilab Enterprises
7  *
8  * This file is hereby licensed under the terms of the GNU GPL v2.0,
9  * pursuant to article 5.3.4 of the CeCILL v.2.1.
10  * This file was originally licensed under the terms of the CeCILL v2.1,
11  * and continues to be available under such terms.
12  * For more information, see the COPYING file which you should have received
13  * along with this program.
14     *
15     -->
16 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="wavread" xml:lang="ja">
17     <refnamediv>
18         <refname>wavread</refname>
19         <refpurpose>.wav サウンドファイルを読み込む</refpurpose>
20     </refnamediv>
21     <refsynopsisdiv>
22         <title>呼び出し手順</title>
23         <synopsis>y=wavread(wavfile)
24             y=wavread(wavfile,ext)
25             [y,Fs,bits]=wavread(wavfile)
26             [y,Fs,bits]=wavread(wavfile,ext)
27         </synopsis>
28     </refsynopsisdiv>
29     <refsection>
30         <title>引数</title>
31         <variablelist>
32             <varlistentry>
33                 <term>wavfile</term>
34                 <listitem>
35                     <para>文字列(拡張子が指定されない場合,拡張子 .wav が追加されます)
36                     </para>
37                 </listitem>
38             </varlistentry>
39             <varlistentry>
40                 <term>Fs</term>
41                 <listitem>
42                     <para>整数, サンプリング周波数(単位:Hz) (サンプル数/秒).
43                     </para>
44                 </listitem>
45             </varlistentry>
46             <varlistentry>
47                 <term>ext</term>
48                 <listitem>
49                     <para>
50                         文字列 (<literal>'size'</literal>) または string('info') または
51                         (nサンプルを読み込む)整数 ,
52                         (n1からn2を読み込む) 1 x 2整数ベクトル.
53                     </para>
54                 </listitem>
55             </varlistentry>
56         </variablelist>
57     </refsection>
58     <refsection>
59         <title>説明</title>
60         <para>
61             <literal>.wav</literal>サウンドファイルを読み込む
62             ユーティリティ関数.
63             <literal>wavread(wavfile)</literal> は文字列wavfileで
64             指定されたサウンドファイルを読み込み,サンプルデータをyに返します.
65             大きさは [-1,+1]の範囲となります.
66             以下の形式の多チャネルデータをサポートします:
67             8-bit mu-law, 8-, 16-, および 32ビット,線形, および浮動小数点.
68         </para>
69         <para>
70             <literal>[y,Fs,bits]=wavread(wavfile)</literal> は,
71             ファイル中のデータをエンコードする際に使用された
72             サンプルレート(Fs) (単位:Hz),ビット数/サンプルを返します.
73         </para>
74         <para>
75             <literal>wavread(wavfile,n)</literal>は各チャネルの最初のnサンプルを
76             返します.
77         </para>
78         <para>
79             <literal>wavread(wavfile,[n1,n2])</literal> はサンプル n1 から n2までを返します.
80         </para>
81         <para>
82             <literal>wavread(wavfile,'size')</literal> は,
83             ファイル中に含まれるオーディオデータの大きさを
84             [チャネル サンプル] のベクトルとして返します.
85         </para>
86         <para>
87             <literal>wavread(wavfile,'info')</literal> は,
88             実際のオーディオデータについて
89             ファイル中に含まれるオーディオデータに関する情報を,
90             ベクトル
91             [データ形式, チャネル数, サンプル/秒/チャネル, 所要バイト/秒の推定値,
92             基本サンプルブロックのバイト並び, ビット/秒, サウンドデータ長(単位:バイト),
93             バイト/サンプル (チャネル毎)]
94             として返します.
95         </para>
96     </refsection>
97     <refsection>
98         <title>例</title>
99         <programlisting role="example"><![CDATA[
100 wavread("SCI/modules/sound/demos/chimes.wav","size")
101 [y,Fs,bits]=wavread("SCI/modules/sound/demos/chimes.wav");Fs,bits
102 subplot(2,1,1)
103 plot2d(y(1,:)) // 最初のチャネル
104 subplot(2,1,2)
105 plot2d(y(2,:)) // 2番目のチャネル
106 y=wavread("SCI/modules/sound/demos/chimes.wav",[1 5]) //最初の5サンプル
107  ]]></programlisting>
108         <scilab:image>
109             wavread("SCI/modules/sound/demos/chimes.wav","size")
110             [y,Fs,bits]=wavread("SCI/modules/sound/demos/chimes.wav");
111             subplot(2,1,1)
112             plot2d(y(1,:))
113             subplot(2,1,2)
114             plot2d(y(2,:))
115             y=wavread("SCI/modules/sound/demos/chimes.wav",[1 5])
116         </scilab:image>
117     </refsection>
118     <refsection role="see also">
119         <title>参照</title>
120         <simplelist type="inline">
121             <member>
122                 <link linkend="auread">auread</link>
123             </member>
124             <member>
125                 <link linkend="savewave">savewave</link>
126             </member>
127             <member>
128                 <link linkend="analyze">analyze</link>
129             </member>
130             <member>
131                 <link linkend="mapsound">mapsound</link>
132             </member>
133         </simplelist>
134     </refsection>
135 </refentry>