hh` SrSrSSKrSSKrSSKJrJrJr SSK J r SSK J r \rSSS S S S S SSSS. r0SS_SS_SS_SS_SS_SS_SS_S S!_S"S#_S$S%_S&S'_S(S)_S*S+_S,S-_S.S/_S0S1_S2S3_S4S5S6S7S8S9S:S;SS_S?S_S@S _SAS _SBS _SCS _SDS _SES_SFSG_SHSI_SJSK_SLSM_SNSO_SPSQ_SRSS_STSU_SVSW_0SXSY_SZS[_S\S]_S^S__S`Sa_SbSc_SdSe_SfSg_ShSi_SjSk_SlSm_SnSo_SpSq_SrSs_StSu_SvSw_SxSy_ErSSzS{S|S}.r0SS?_SS?_SS?_SS?_SS?_SS?_S S?_S"S?_S$S?_S&SD_S(SD_S*S?_S,Sf_S.S?_S0S?_S2S?_S~S?_S?S?S?SFShS?S?SxS.ErSSSSS.rSSSS.r\R4S:XaSSKJr S\"5-S-rO\R4S:XaPSSKJr SSKJr \"5SS:XaSrOm\"5SS:XaSrO\\ "SRC\"5\"555e\R4S:Xa"SSKJr \"5S;aSrOS\"5-S-rO\ "S5eSSK"r"\RFRI\"RJ5r&\RFRO\&\5r(\RR"\(5r*\Rb"\*Re55RgSS5r4\4RkS5(a \4\6"S5Sr4SSjr7SSjr8SSjr9"SS\:5r;SSjrSSjr?Sr@"SS\:5rASSjrBSrCSrDSrESrFSrG\*R4SjrISrJSrKSrL"SS\M5rN"SS\N\O5rP"SS\P5rQg!\a \rGNf=f!\ \+\,4a \ "S5r-\-c\ "S5e\RR"\-5r*GN%!\ a \R4S:XaSr.O'\R4S:XaSr.O\R4S:XaSr.OeSSKJr \R4S:Xa_\"5S:XaT\RFR_S5(aSOSr0\RR"\RFRO\0\.55r*GN\RR"\.5r*GNf=ff=f)akpython-soundfile is an audio library based on libsndfile, CFFI and NumPy. Sound files can be read or written directly using the functions `read()` and `write()`. To read a sound file in a block-wise fashion, use `blocks()`. Alternatively, sound files can be opened as `SoundFile` objects. For further information, see https://python-soundfile.readthedocs.io/. z0.13.1N)SEEK_SETSEEK_CURSEEK_END) find_library)ffi ) title copyrightsoftwareartistcommentdatealbumlicense tracknumbergenreWAViAIFFiAUiRAWiPAFiSVXiNISTiVOCiIRCAMi W64i MAT4i MAT5i PVFiXIiHTKiSDSiAVRiiiiiii i!i"i#) WAVEXSD2FLACCAFWVEOGGMPC2KRF64MP3PCM_S8PCM_16PCM_24PCM_32PCM_U8FLOATDOUBLEULAWALAW IMA_ADPCMMS_ADPCMGSM610 VOX_ADPCM! NMS_ADPCM_16" NMS_ADPCM_24# NMS_ADPCM_32$G721_320G723_241G723_402DWVW_12@DWVW_16ADWVW_24BDWVW_NCDPCM_8PDPCM_16QVORBIS`OPUSdALAC_16pALAC_20qALAC_24rALAC_32s MPEG_LAYER_I MPEG_LAYER_IIMPEG_LAYER_IIIii i0)FILELITTLEBIGCPUr-)r.r/r0r1r2r3r4r5doublefloatintshort)float64float32int32int16)CONSTANTAVERAGEVARIABLEdarwin)machine libsndfile_z.dylibwin32) architecture64bitzlibsndfile_x64.dll32bitzlibsndfile_x86.dllz%no packaged library for Windows {} {}linux)aarch64 aarch64_bearmv8barmv8lzlibsndfile_arm64.soz.soz%no packaged library for this platformsndfilez8sndfile library not found using ctypes.util.find_libraryzlibsndfile.dylibzlibsndfile.dllz libsndfile.soarm64z/opt/homebrew/lib/z/usr/local/lib/utf-8replacez libsndfile-c [USXXX5nURX#U5nURXXVU5nSSS5 WWR4$!,(df  N=f)a Provide audio data from a sound file as NumPy array. By default, the whole file is read from the beginning, but the position to start reading can be specified with *start* and the number of frames to read can be specified with *frames*. Alternatively, a range can be specified with *start* and *stop*. If there is less data left in the file than requested, the rest of the frames are filled with *fill_value*. If no *fill_value* is specified, a smaller array is returned. Parameters ---------- file : str or int or file-like object The file to read from. See `SoundFile` for details. frames : int, optional The number of frames to read. If *frames* is negative, the whole rest of the file is read. Not allowed if *stop* is given. start : int, optional Where to start reading. A negative value counts from the end. stop : int, optional The index after the last frame to be read. A negative value counts from the end. Not allowed if *frames* is given. dtype : {'float64', 'float32', 'int32', 'int16'}, optional Data type of the returned array, by default ``'float64'``. Floating point audio data is typically in the range from ``-1.0`` to ``1.0``. Integer data is in the range from ``-2**15`` to ``2**15-1`` for ``'int16'`` and from ``-2**31`` to ``2**31-1`` for ``'int32'``. .. note:: Reading int values from a float file will *not* scale the data to [-1.0, 1.0). If the file contains ``np.array([42.6], dtype='float32')``, you will read ``np.array([43], dtype='int32')`` for ``dtype='int32'``. Returns ------- audiodata : `numpy.ndarray` or type(out) A two-dimensional (frames x channels) NumPy array is returned. If the sound file has only one channel, a one-dimensional array is returned. Use ``always_2d=True`` to return a two-dimensional array anyway. If *out* was specified, it is returned. If *out* has more frames than available in the file (or if *frames* is smaller than the length of *out*) and no *fill_value* is given, then only a part of *out* is overwritten and a view containing all valid frames is returned. samplerate : int The sample rate of the audio file. Other Parameters ---------------- always_2d : bool, optional By default, reading a mono sound file will return a one-dimensional array. With ``always_2d=True``, audio data is always returned as a two-dimensional array, even if the audio file has only one channel. fill_value : float, optional If more frames are requested than available in the file, the rest of the output is be filled with *fill_value*. If *fill_value* is not specified, a smaller array is returned. out : `numpy.ndarray` or subclass, optional If *out* is specified, the data is written into the given array instead of creating a new array. In this case, the arguments *dtype* and *always_2d* are silently ignored! If *frames* is not given, it is obtained from the length of *out*. samplerate, channels, format, subtype, endian, closefd See `SoundFile`. Examples -------- >>> import soundfile as sf >>> data, samplerate = sf.read('stereo_file.wav') >>> data array([[ 0.71329652, 0.06294799], [-0.26450912, -0.38874483], ... [ 0.67398441, -0.11516333]]) >>> samplerate 44100 rN) SoundFile _prepare_readread samplerate)fileframesstartstopdtype always_2d fill_valueoutrchannelsformatsubtypeendianclosefdfdatas C/home/james-whalen/.local/lib/python3.13/site-packages/soundfile.pyrrs^l 4jF 589f5vvfYC@ 5    5 5s &A  Ac SSKn U RU5nURS:XaSn OURSn [ USX*X4XVXx5 n U R U5 SSS5 g!,(df  g=f)aWrite data to a sound file. .. note:: If *file* exists, it will be truncated and overwritten! Parameters ---------- file : str or int or file-like object The file to write to. See `SoundFile` for details. data : array_like The data to write. Usually two-dimensional (frames x channels), but one-dimensional *data* can be used for mono files. Only the data types ``'float64'``, ``'float32'``, ``'int32'`` and ``'int16'`` are supported. .. note:: The data type of *data* does **not** select the data type of the written file. Audio data will be converted to the given *subtype*. Writing int values to a float file will *not* scale the values to [-1.0, 1.0). If you write the value ``np.array([42], dtype='int32')``, to a ``subtype='FLOAT'`` file, the file will then contain ``np.array([42.], dtype='float32')``. samplerate : int The sample rate of the audio data. subtype : str, optional See `default_subtype()` for the default value and `available_subtypes()` for all possible values. Other Parameters ---------------- format, endian, closefd, compression_level, bitrate_mode See `SoundFile`. Examples -------- Write 10 frames of random data to a new file: >>> import numpy as np >>> import soundfile as sf >>> sf.write('stereo_file.wav', np.random.randn(10, 2), 44100, 'PCM_24') rNrw)numpyasarrayndimshaperwrite) rrrrrrrcompression_level bitrate_modenprrs rrr8sgZ ::d D yyA~::a= 4jF$ 478   4 4 4s A## A1c ## [USXXX5nURXEU5nURXUXgX5HnUv M SSS5 g!,(df  g=f7f)aReturn a generator for block-wise reading. By default, iteration starts at the beginning and stops at the end of the file. Use *start* to start at a later position and *frames* or *stop* to stop earlier. If you stop iterating over the generator before it's exhausted, the sound file is not closed. This is normally not a problem because the file is opened in read-only mode. To close the file properly, the generator's ``close()`` method can be called. Parameters ---------- file : str or int or file-like object The file to read from. See `SoundFile` for details. blocksize : int The number of frames to read per block. Either this or *out* must be given. overlap : int, optional The number of frames to rewind between each block. Yields ------ `numpy.ndarray` or type(out) Blocks of audio data. If *out* was given, and the requested frames are not an integer multiple of the length of *out*, and no *fill_value* was given, the last block will be a smaller view into *out*. Other Parameters ---------------- frames, start, stop See `read()`. dtype : {'float64', 'float32', 'int32', 'int16'}, optional See `read()`. always_2d, fill_value, out See `read()`. samplerate, channels, format, subtype, endian, closefd See `SoundFile`. Examples -------- >>> import soundfile as sf >>> for block in sf.blocks('stereo_file.wav', blocksize=1024): >>> pass # do something with 'block' rN)rrblocks)r blocksizeoverlaprrrrrrrrrrrrrrblocks rrrqs`f 4jF 589f5XXi&# AEKA 5 5 5sA2A  A AAc4\rSrSrSrSr\S5rSrSr g)_SoundFileInfoizInformation about a SoundFilecX l[U5nURUlURUlURUlUR Ul[ UR 5UR- UlURUlURUl URUl URUl URUl URUl URUlSSS5 g!,(df  g=fN)verbosernamerrrrwdurationrrr format_info subtype_infosections extra_info)selfrrrs r__init___SoundFileInfo.__init__s t_DIllDOJJDM((DK!$++.q||;DM((DK99DL((DK }}D  !D JJDMllDO__s C#C>> D c [URS5up[US5up4US:aSRXU5nU$US:aSRX45nU$US::aSRUR5nU$SRU5nU$)Ni<rz{0:.0g}:{1:02.0g}:{2:05.3f} hz{0:02.0g}:{1:05.3f} minz {0:d} samplesz {0:.3f} s)divmodrrr)rhoursrestminutessecondsrs r _duration_str_SoundFileInfo._duration_strsT]]D1 !$+ A:6==egVH \077IH  \&--dkk:H#))'2HcSR/SQ5nUR(aUSR/SQ5- nSRURRS55nUR X5$)N )z{0.name}zsamplerate: {0.samplerate} Hzzchannels: {0.channels}zduration: {0._duration_str}z$format: {0.format_info} [{0.format}]z'subtype: {0.subtype_info} [{0.subtype}])z endian: {0.endian}zsections: {0.sections}zframes: {0.frames}zextra_info: """z {1}"""z )joinrrsplitr)rinfoindented_extra_infos r__repr___SoundFileInfo.__repr__siyy 89 << DII  D *//0E0Ed0KL{{455r) rrrrrrrrrrrrrN) __name__ __module__ __qualname____firstlineno____doc__rpropertyrr__static_attributes__rrrrs#'+   6rrc[X5$)zReturns an object with information about a `SoundFile`. Parameters ---------- verbose : bool Whether to print additional information. )r)rrs rrrs $ ((rcd[[[R[R55$)auReturn a dictionary of available major formats. Examples -------- >>> import soundfile as sf >>> sf.available_formats() {'FLAC': 'FLAC (FLAC Lossless Audio Codec)', 'OGG': 'OGG (OGG Container format)', 'WAV': 'WAV (Microsoft)', 'AIFF': 'AIFF (Apple/SGI)', ... 'WAVEX': 'WAVEX (Microsoft)', 'RAW': 'RAW (header-less)', 'MAT5': 'MAT5 (GNU Octave 2.1 / Matlab 5.0)'} )dict_available_formats_helper_sndSFC_GET_FORMAT_MAJOR_COUNTSFC_GET_FORMAT_MAJORrrravailable_formatsrs-" )$*I*I*.*C*CE FFrc~^[[R[R5n[ U4SjU55$)a4Return a dictionary of available subtypes. Parameters ---------- format : str If given, only compatible subtypes are returned. Examples -------- >>> import soundfile as sf >>> sf.available_subtypes('FLAC') {'PCM_24': 'Signed 24 bit PCM', 'PCM_16': 'Signed 16 bit PCM', 'PCM_S8': 'Signed 8 bit PCM'} c3Z># UH upTb[TU5(dMX4v M" g7fr) check_format).0rrrs r %available_subtypes..s+DXMG>\&'%B Xs+ +)rrSFC_GET_FORMAT_SUBTYPE_COUNTSFC_GET_FORMAT_SUBTYPEr)rsubtypess` ravailable_subtypesrs>"))J)J)-)D)DFH DXD DDrcZ[[XU55$![[4a gf=f)zCheck if the combination of format/subtype/endian is valid. Examples -------- >>> import soundfile as sf >>> sf.check_format('WAV', 'PCM_24') True >>> sf.check_format('FLAC', 'VORBIS') False F)bool _format_int ValueError TypeError)rrrs rrrs0K899  "s **c^[U5 [RUR55$)zReturn the default subtype for a given format. Examples -------- >>> import soundfile as sf >>> sf.default_subtype('WAV') 'PCM_16' >>> sf.default_subtype('MAT5') 'DOUBLE' ) _check_format_default_subtypesgetupper)rs rdefault_subtyper)s#&   00rc^\rSrSrSrS:Sjr\"S5r\"S5r\"S5r \"S5r \"S 5r \"S 5r \"S 5r \"S 5r\"S 5r\"S5r\"S5r\"S5r\"S5r\"S5r\"S5r\S5rSrSrSrSrSrSrSrSrSrSr Sr!\"4Sjr#S r$S;S!jr%SS'jr+S(r,S)r-S*r.S+r/S,r0S-r1S.r2S/r3S0r4S1r5S2r6S3r7S4r8S5r9S6r:S7r;S8r`__. bitrate_mode : {'CONSTANT', 'AVERAGE', 'VARIABLE'}, optional The bitrate mode on 'write()'. See `libsndfile document `__. Examples -------- >>> from soundfile import SoundFile Open an existing file for reading: >>> myfile = SoundFile('existing_file.wav') >>> # do something with myfile >>> myfile.close() Create a new sound file for reading and writing using a with statement: >>> with SoundFile('new_file.wav', 'x+', 44100, 2) as myfile: >>> # do something with myfile >>> # ... >>> assert not myfile.closed >>> # myfile.close() is called automatically at the end >>> assert myfile.closed __fspath__Nmodezr+r)hasattrr_namegetattr _check_mode_mode_compression_level _bitrate_mode_create_info_struct_info_open_fileset issupersetseekableseekr sf_commandSFC_SET_CLIPPING_ffiNULLSF_TRUE_set_compression_level_set_bitrate_mode) rrrrrrrrrrrmode_ints rrSoundFile.__init__AsN%,D,$?$?t T <4.Dt$ "3)(Z)/&B ZZ8 t9   % %$--// IIaL  D$9$9499  &  " " .  ' '(?(? @!!-&&t'9'9:. /rcUR$r)rrs rSoundFile.rcUR$r)rrs rrrrrc.URR$r)rrrs rrrstzz'<'rch[URR[R-5S$r+)r,rrrr&rs rrrs+\$**"3"3"&"8"8#9::;=rc.URR$r)rrrs rrrr!rcURSL$r)r rs rrrs 4::#5rc@[RUR5$r)rsf_errorr rs rrrst}}TZZ'@rcUR$r)rrs rrrs d.E.ErcUR$r)rrs rrrs ););rc[R"SS5n[RUR[R U[R "U55 [R"U5RSS5$)z8Retrieve the log string generated when opening the file.zchar[]i@rr) rnewrrr SFC_GET_LOG_INFOsizeofstringdecode)rrs rrSoundFile.extra_infosXxx%(  D$9$9dkk$/ 1{{4 '';;rcURbSRUR5OSnUURbSRUR5OS- nSRX5$)Nz, compression_level={0}z, bitrate_mode='{0}'zSoundFile({0.name!r}, mode={0.mode!r}, samplerate={0.samplerate}, channels={0.channels}, format={0.format!r}, subtype={0.subtype!r}, endian={0.endian!r}{1}))rrr)rcompression_settings rrSoundFile.__repr__st"&"8"8"D 9??@V@VWJL #'#4#4#@!7 = =d>O>O PFH J*+1&*K Mrc$UR5 grclosers r__del__SoundFile.__del__  rcU$rrrs r __enter__SoundFile.__enter__s rc$UR5 grr@)rargss r__exit__SoundFile.__exit__rDrcU[;aRUR5 [RUR[UUR 55n[ U5 g[RXU5 g)z:Write text meta-data in the sound file through properties.N) _str_types_check_if_closedr sf_set_stringr encode _error_checkobject __setattr__)rrvalueerrs rrSSoundFile.__setattr__sT :   ! ! #$$TZZD1A%*\\^5C     t5 1rcU[;afUR5 [RUR[U5nU(a&[ R "U5RSS5$S$[SRU55e)z9Read text meta-data in the sound file through properties.rrr<z)'SoundFile' object has no attribute {0!r}) rMrNr sf_get_stringr rr8r9AttributeErrorr)rrrs r __getattr__SoundFile.__getattr__sq :   ! ! #%%djj*T2BCDCG4;;t$++GY? OR O ;BB4HJ Jrc.URR$rrrs r__len__SoundFile.__len__szz   rcg)NTrrs r__bool__SoundFile.__bool__src"UR5$r)r`rs r __nonzero__SoundFile.__nonzero__"s}}rcPURR[R:H$)z)Return True if the file supports seeking.)rr rrrs rr SoundFile.seekable'szz""dll22rcUR5 [RURX5n[ UR 5 U$)a Set the read/write position. Parameters ---------- frames : int The frame index or offset to seek. whence : {SEEK_SET, SEEK_CUR, SEEK_END}, optional By default (``whence=SEEK_SET``), *frames* are counted from the beginning of the file. ``whence=SEEK_CUR`` seeks from the current position (positive and negative values are allowed for *frames*). ``whence=SEEK_END`` seeks from the end (use negative value for *frames*). Returns ------- int The new absolute read/write position in frames. Examples -------- >>> from soundfile import SoundFile, SEEK_END >>> myfile = SoundFile('stereo_file.wav') Seek to the beginning of the file: >>> myfile.seek(0) 0 Seek to the end of the file: >>> myfile.seek(0, SEEK_END) 44100 # this is the file length )rNrsf_seekr rQ _errorcode)rrwhencepositions rr SoundFile.seek+s6H << F;T__%rc.URS[5$)z'Return the current read/write position.r)r rrs rtellSoundFile.tellTsyyH%%rcUc$URX5nURXU5nO US:dU[U5:a [U5nURSXQ5n[U5U:aUcUSUnU$XEUS&U$)a Read from the file and return data as NumPy array. Reads the given number of frames in the given data format starting at the current read/write position. This advances the read/write position by the same number of frames. By default, all frames from the current read/write position to the end of the file are returned. Use `seek()` to move the current read/write position. Parameters ---------- frames : int, optional The number of frames to read. If ``frames < 0``, the whole rest of the file is read. dtype : {'float64', 'float32', 'int32', 'int16'}, optional Data type of the returned array, by default ``'float64'``. Floating point audio data is typically in the range from ``-1.0`` to ``1.0``. Integer data is in the range from ``-2**15`` to ``2**15-1`` for ``'int16'`` and from ``-2**31`` to ``2**31-1`` for ``'int32'``. .. note:: Reading int values from a float file will *not* scale the data to [-1.0, 1.0). If the file contains ``np.array([42.6], dtype='float32')``, you will read ``np.array([43], dtype='int32')`` for ``dtype='int32'``. Returns ------- audiodata : `numpy.ndarray` or type(out) A two-dimensional NumPy (frames x channels) array is returned. If the sound file has only one channel, a one-dimensional array is returned. Use ``always_2d=True`` to return a two-dimensional array anyway. If *out* was specified, it is returned. If *out* has more frames than available in the file (or if *frames* is smaller than the length of *out*) and no *fill_value* is given, then only a part of *out* is overwritten and a view containing all valid frames is returned. Other Parameters ---------------- always_2d : bool, optional By default, reading a mono sound file will return a one-dimensional array. With ``always_2d=True``, audio data is always returned as a two-dimensional array, even if the audio file has only one channel. fill_value : float, optional If more frames are requested than available in the file, the rest of the output is be filled with *fill_value*. If *fill_value* is not specified, a smaller array is returned. out : `numpy.ndarray` or subclass, optional If *out* is specified, the data is written into the given array instead of creating a new array. In this case, the arguments *dtype* and *always_2d* are silently ignored! If *frames* is not given, it is obtained from the length of *out*. Examples -------- >>> from soundfile import SoundFile >>> myfile = SoundFile('stereo_file.wav') Reading 3 frames from a stereo file: >>> myfile.read(3) array([[ 0.71329652, 0.06294799], [-0.26450912, -0.38874483], [ 0.67398441, -0.11516333]]) >>> myfile.close() See Also -------- buffer_read, .write Nrr) _check_frames_create_empty_arraylen _array_io)rrrrrrs rrSoundFile.readXs` ;'';F**6eDCzVc#h.S4 s8f !'6l  *FG  rcURUSS9nURU5n[R"US-XR-5nUR SXCU5nXQ:Xde[R "U5$)aRead from the file and return data as buffer object. Reads the given number of *frames* in the given data format starting at the current read/write position. This advances the read/write position by the same number of frames. By default, all frames from the current read/write position to the end of the file are returned. Use `seek()` to move the current read/write position. Parameters ---------- frames : int, optional The number of frames to read. If ``frames < 0``, the whole rest of the file is read. dtype : {'float64', 'float32', 'int32', 'int16'} Audio data will be converted to the given data type. Returns ------- buffer A buffer containing the read data. See Also -------- buffer_read_into, .read, buffer_write N)rz[]r)rq _check_dtyperr5r _cdata_iobuffer)rrrctypecdata read_framess r buffer_readSoundFile.buffer_readsq8##Ft#<!!%(v '=>nnVU6B $$${{5!!rctURU5nURX5upEURSXCU5nU$)aRead from the file into a given buffer object. Fills the given *buffer* with frames in the given data format starting at the current read/write position (which can be changed with `seek()`) until the buffer is full or the end of the file is reached. This advances the read/write position by the number of frames that were read. Parameters ---------- buffer : writable buffer Audio frames from the file are written to this buffer. dtype : {'float64', 'float32', 'int32', 'int16'} The data type of *buffer*. Returns ------- int The number of frames that were read from the file. This can be less than the size of *buffer*. The rest of the buffer is not filled with meaningful data. See Also -------- buffer_read, .read r)rw _check_bufferrx)rryrrzr{rs rbuffer_read_intoSoundFile.buffer_read_intos=8!!%(**69 f= rcSSKnURU5nURSU[U55nU[U5:XdeUR U5 g)aWrite audio data from a NumPy array to the file. Writes a number of frames at the read/write position to the file. This also advances the read/write position by the same number of frames and enlarges the file if necessary. Note that writing int values to a float file will *not* scale the values to [-1.0, 1.0). If you write the value ``np.array([42], dtype='int32')``, to a ``subtype='FLOAT'`` file, the file will then contain ``np.array([42.], dtype='float32')``. Parameters ---------- data : array_like The data to write. Usually two-dimensional (frames x channels), but one-dimensional *data* can be used for mono files. Only the data types ``'float64'``, ``'float32'``, ``'int32'`` and ``'int16'`` are supported. .. note:: The data type of *data* does **not** select the data type of the written file. Audio data will be converted to the given *subtype*. Writing int values to a float file will *not* scale the values to [-1.0, 1.0). If you write the value ``np.array([42], dtype='int32')``, to a ``subtype='FLOAT'`` file, the file will then contain ``np.array([42.], dtype='float32')``. Examples -------- >>> import numpy as np >>> from soundfile import SoundFile >>> myfile = SoundFile('stereo_file.wav') Write 10 frames of random data to a new file: >>> with SoundFile('stereo_file.wav', 'w', 44100, 2, 'PCM_24') as f: >>> f.write(np.random.randn(10, 2)) See Also -------- buffer_write, .read rNr)rascontiguousarrayrtrs_update_frames)rrrwrittens rrSoundFile.writesP\ ##D)..$D :#d)### G$rcURU5nURX5upEURSXCU5nXe:XdeURU5 g)aWrite audio data from a buffer/bytes object to the file. Writes the contents of *data* to the file at the current read/write position. This also advances the read/write position by the number of frames that were written and enlarges the file if necessary. Parameters ---------- data : buffer or bytes A buffer or bytes object containing the audio data to be written. dtype : {'float64', 'float32', 'int32', 'int16'} The data type of the audio data stored in *data*. See Also -------- .write, buffer_read rN)rwrrxr)rrrrzr{rrs r buffer_writeSoundFile.buffer_write0sR*!!%(**47 ..%?    G$rc #x# SSKnSUR;aSUR;a [S5eURX65nUc3Uc [ S5eUbUO [ X5n UR XU5nSn OUb [ S5e[U5nS n Sn US:aU cSn O[U 5n XSU &[ X- U5n URXXVX|S5 U(a U cURXr*S5n OXr*SU SS&XU-:a UcUSX2-nOUnU (aURU5OUv X=-nUS:aMgg7f) aReturn a generator for block-wise reading. By default, the generator yields blocks of the given *blocksize* (using a given *overlap*) until the end of the file is reached; *frames* can be used to stop earlier. Parameters ---------- blocksize : int The number of frames to read per block. Either this or *out* must be given. overlap : int, optional The number of frames to rewind between each block. frames : int, optional The number of frames to read. If ``frames < 0``, the file is read until the end. dtype : {'float64', 'float32', 'int32', 'int16'}, optional See `read()`. Yields ------ `numpy.ndarray` or type(out) Blocks of audio data. If *out* was given, and the requested frames are not an integer multiple of the length of *out*, and no *fill_value* was given, the last block will be a smaller view into *out*. Other Parameters ---------------- always_2d, fill_value, out See `read()`. fill_value : float, optional See `read()`. out : `numpy.ndarray` or subclass, optional If *out* is specified, the data is written into the given array instead of creating a new array. In this case, the arguments *dtype* and *always_2d* are silently ignored! Examples -------- >>> from soundfile import SoundFile >>> with SoundFile('stereo_file.wav') as f: >>> for block in f.blocks(blocksize=1024): >>> pass # do something with 'block' rNr+z*blocks() is not allowed in write-only modez)One of {blocksize, out} must be specifiedTz-Only one of {blocksize, out} may be specifiedF) rrSoundFileRuntimeErrorrqrminrrrsrcopy)rrrrrrrrrout_sizecopy_outoverlap_memory output_offsettoreadrs rrSoundFile.blocksKsgd  dii Ctyy$8'(TU U##F7 ;  KLL$.$:yI@VH**8FCH$CEECIHqj% ! #N 3 &4N]#2F;F IIfYCYY[Foodjj$*@*@"hh}f="kk,79 -- +C!#'BC C" rcbUR5 [RUR5 g)a:Write unwritten data to the file system. Data written with `write()` is not immediately written to the file system but buffered in memory to be written at a later time. Calling `flush()` makes sure that all changes are actually written to the file system. This has no effect on files opened in read-only mode. N)rNr sf_write_syncr rs rflushSoundFile.flushs"  4::&rcUR(dBUR5 [RUR5nSUl[ U5 gg)z.Close the file. Can be called multiple times.N)closedrrsf_closer rQ)rrUs rrASoundFile.closes8{{ JJL-- +CDJ   rc[U[[45(GaM[RR U5(aSUR ;a$[SRUR55e[UR 5RS5(aJ[R"[R"U[R[R-55 [ R"n[U[5(aI[$R&S:Xa[ R(nO$UR+[$R,"55nU"XUR.5nO[U[05(a"[ R3XUR.U5nOs[5X5(a?[ R7UR9U5X R.[:R<5nO$[?SRUR55eU[:R<:Xa8[ RAU5n[CUSRUR5S9eU[ RD:XaSUR.l#U$) z9Call the appropriate sf_open*() function from libsndfile.xzFile exists: {0!r}zw+rzInvalid file: {0!r}zError opening {0!r}: prefixr)$ isinstance_unicodebytes_ospathisfilerOSErrorrrr r rAopenO_WRONLYO_TRUNCrsf_open_sysplatform sf_wchar_openrPgetfilesystemencodingrrx sf_open_fd_has_virtual_io_attrssf_open_virtual_init_virtual_iorrrr1r SFM_WRITEr)rrrr openfunctionfile_ptrrUs rrSoundFile._opens dXu- . .xxt$$$))#!"6"="=dii"HII^..t44IIchhtS\\CKK-GHI<TR5nTRS[5 TR5nTRU[5 U$Nr)rnr rr) user_datacurrsizers rvio_get_filelen3SoundFile._init_virtual_io..vio_get_filelens:99;D IIa "99;D IIdH %Kr sf_vio_seekcF>TRX5 TR5$r)r rn)offsetrjrrs rvio_seek,SoundFile._init_virtual_io..vio_seeks IIf %99; r sf_vio_readc>[R"X5nTRU5nU$![a: TR U5n[ U5n[R"X5nXSSU&U$f=fr)rryreadintorYrrs)ptrcountrbuf data_readrrs rvio_read,SoundFile._init_virtual_io..vio_read sr (kk#- MM#.   " (yy'I kk#1#'Ai    (s',AA0/A0 sf_vio_writecj>[R"X5nUSSnTRU5nUcUnU$r)rryr)rrrrrrrs r vio_write-SoundFile._init_virtual_io..vio_writes7++c)Cq6Djj&GNr sf_vio_tellc$>TR5$r)rn)rrs rvio_tell,SoundFile._init_virtual_io..vio_tell!s99; r) get_filelenr rrrnzSF_VIRTUAL_IO*)rcallback _virtual_ior5)rrrrrrrs ` rrSoundFile._init_virtual_ios + ,  -  } %  &  } %  &  ~ &  '  } %  & ,;$,$,%.$, . xx($*:*:;;rc[$)zpReturn all attributes used in __setattr__ and __getattr__. This is useful for auto-completion (e.g. IPython). )rMrs r_getAttributeNamesSoundFile._getAttributeNames.s rc<UR(a [S5eg)zuCheck if the file is closed and raise an error if it is. This should be used in every method that uses self._file. zI/O operation on closed fileN)rrrs rrNSoundFile._check_if_closed6s ;;'(FG G rcUR5(a/URUR5- nUS:dX:aUcUnU$US:a [S5eU$)z8Reduce frames to no more than are available in the file.rz/frames must be specified for non-seekable files)r rrnr)rrrremaining_framess rrqSoundFile._check_frames?sZ ==??#{{TYY[8 zf7(0) aZNO O rc&U[R5;de[U[5(d[R "U5n[ [U5UR[R"U5-5up4U(a [S5eX4$)z1Convert buffer to cdata and check for valid size.z*Data size must be a multiple of frame size) _ffi_typesvaluesrrr from_bufferrrsrr7r)rrrzr remainders rrSoundFile._check_bufferJsv ))++++$&&##D)D"3t9#'==4;;u3E#EG IJ J|rczSSKnU(dURS:aXR4nOU4nURXSSS9$)z-Create an empty array with appropriate shape.rNrC)order)rrempty)rrrrrrs rrrSoundFile._create_empty_arrayUs9  )MM)EGExxCx00rc [U$![a7 [SR[ [R 55U55ef=f)z7Check if dtype string is valid and return ctype string.z(dtype must be one of {0!r} and not {1!r})rKeyErrorrrsortedkeys)rrs rrwSoundFile._check_dtype^sM 3e$ $ 3GNNz()523 3 3s  AA cURS;a?[SRURURS:a S55eS55eURS:XaSOURSnX@R:wa0[SRURURU55eUR R (d [S5eURURR5nURR[R"U5:Xde[R"US-URS S 5nURXXS5$) z+Check array and call low-level IO function.)rr zInvalid shape: {0!r} ({1})rz0 dimensions not supportedztoo many dimensionsz5Invalid shape: {0!r} (Expected {1} channels, got {2})zData must be C-contiguous*rr)rrrrrflags c_contiguousrwrritemsizerr7cast__array_interface__rx)ractionarrayrarray_channelsrzr{s rrtSoundFile._array_iofs@ ::U "9@@nsnxnx{|n|NjYZ ZCXYZ Z#jjAo5;;q> ]] *T[[\a\g\gimivivyGHI I{{''89 9!!%++"2"23{{##t{{5'9999 %#+u'@'@'H'KL~~fU;;rcU[R5;deUR5 UR5(aUR 5n[ [ SU-S-U-5nU"URX$5n[UR5 UR5(aURWU-[5 U$)z.Call one of libsndfile's read/write functions.sf_f_) rrrNr rnrrr rQrir r)rrrrzrrfuncs rrxSoundFile._cdata_iots ))++++  ==??99;DtUV^d2U:;djj$/T__% ==?? IIdVmX . rcUR5(aLUR5nURS[5URlURU[ 5 gUR=R U- slg)z!Update self.frames after writing.rN)r rnr rrrr)rrrs rrSoundFile._update_framessR ==??99;D $ !X 6DJJ  IIdH % JJ   ( rc@US:wa UR5(d [S5eUS:aUb [S5e[X5R UR 5upnX!:aUnUS:aX!- nUR5(aUR U[5 U$)z)Seek to start frame and calculate length.rz(start is only allowed for seekable filesz&Only one of {frames, stop} may be used)r rrsliceindicesrr r)rrrr_s rrSoundFile._prepare_reads A:dmmooGH H Q;4+DE Eu+33DKK@Q <D A:\F ==?? IIeX & rc0n[R5HVup#[RURU5nU(dM.[ R "U5RSS5X'MX U$)zGet all metadata present in this SoundFile Returns ------- metadata: dict[str, str] A dict with all metadata. Possible keys are: 'title', 'copyright', 'software', 'artist', 'comment', 'date', 'album', 'license', 'tracknumber' and 'genre'. rr)rMitemsrrXr rr8r9)rstrsstrtypestridrs r copy_metadataSoundFile.copy_metadatas](..0NG%%djj%8Dt $ D 1 8 8) L 1 rclU[;de[R"S5n[UUS'[R UR [R U[R"U55nU[R:wa.[RUR 5n[USU35eg)z,Call libsndfile's set bitrate mode function.zint[1]rzError set bitrate mode N) _bitrate_modesrr5rrr SFC_SET_BITRATE_MODEr7rr1r)rrpointer_bitrate_moderUs rrSoundFile._set_bitrate_modes~---#xx1"0">Qoodjj$*C*CEY[_[f[fg{[|} $,, -- +C!#)@'OP P rcxSUs=::aS::d O [S5e[R"S5nXS'[R UR [R U[R"U55nU[R:wa.[RUR 5n[USU35eg)z1Call libsndfile's set compression level function.rrz)Compression level must be in range [0..1]z double[1]zError set compression level N) rrr5rrr SFC_SET_COMPRESSION_LEVELr7rr1r)rrpointer_compression_levelrUs rr SoundFile._set_compression_levels&+!+HI I$(HH[$9!'8!$oodjj$*H*HJceiepeprKfLM $,, -- +C!#)EFWEX'YZ Z r)rrr rrrr) rNNNNNTNN)rzFNN)r!N)Nrr!rzFNNr)>rrrrrrrrrrrrrrrrrrrrirrrr rrBrFrJrSrZr]r`rcr rr rnrr}rrrrrrrArrrrNrqrrrrwrtrxrrrrrrrrrrr9sBFAE6:};~ + ,D* + ,D7<=J, 4 5F189H3 MOF-LNG4 LNF8 >?K? =>L:89H3 5 6F2@AJ' !EF,;** 88J DKDM D!T]]2 ?A A M# C188ABBC F5<> OrcUnUc)[X5n[U[[45(deO [ U5 [ R "S5nSU;dUR5S:Xa;Uc [S5eX(l Uc [S5eX8l [XEU5Ul U$[SX#XuU455(a [S5eU$)z*Check arguments and create SF_INFO struct.r$rrzsamplerate must be specifiedzchannels must be specifiedc3(# UHoSLv M g7frr)rargs rr&_create_info_struct..sI+H3$+Hsz\Not allowed for existing files (except 'RAW'): samplerate, channels, format, subtype, endian)_get_format_from_filenamerrr%rrr5rrrrrrany) rrrrrrroriginal_formatrs rrrsO ~*46&8S/2222f 88J D $&,,.E1  :; ;$  89 9 !&6: K Io+HI I ILM M Krc$Sn[USU5n[RRU5SSSnUR SS5nUR 5[;a SU;a[S RU55eU$![ a NFf=f) aReturn a format string obtained from file (or file.name). If file already exists (= read mode), an empty string is returned on error. If not, an exception is raised. The return type will always be str or unicode (even if file/file.name is a bytes object). r<rr!rNrrrzGNo format specified and unable to get format from file extension: {0!r}) rrrsplitextr9 Exceptionr_formatsrr)rrrs rr6r6sF 4 &D ""4(,QR0w 2||~X%#T/006t > > M    s7B BBc|[[[4H'nUR5Hup#X0:XdM Us s $ M) g)z;Return the string representation of a given numeric format.zn/a)r<r&r'r) format_int dictionarykvs rr#r#1s7 83 $$&DA'4 rcN[R"S5nXl[R [R X[R "S55 URn[UR5U(a'[R"U5RSS54$S4$)z6Return the ID and short description of a given format.zSF_FORMAT_INFO*SF_FORMAT_INFOrrr<) rr5rrrrr7rr#r8r9)r> format_flagrrs rr,r,;s((,-K#OODII{KK 013   D  ** +<@DKK  $ $Wi 8 JJFH JJrc## [R"S5n[R[RX[R "S55 [ US5Hn[X15v M g7f)z8Helper for available_formats() and available_subtypes().zint*rxrN)rr5rrrr7ranger,) count_flagrDrr>s rrrFsM HHV EOODIIz$++e2DEE!Ho :33&sA3A5c[U[[45(d[SR U55e[ UR 5nU$![a [SR U55ef=f)z4Check if `format_str` is valid and return format ID.zInvalid format: {0!r}zUnknown format: {0!r}) rrr%rrr<rrr) format_strr>s rrrNsu j8S/ 2 2/66zBCCEj..01   E077 CDDEs A%A5c U[R:HnU[R:Hn[[ US5[ US5[ US5=(d U[ US5=(d [ US5=(d U/5$)z>Check if file has all the necessary attributes for virtual IO.r rnrrr)rr0rallr)rrreadonly writeonlys rrrYsn4==(HDNN*I ffg*(fGz!:Gi  rc\rSrSrSrSrg)SoundFileErroriez-Base class for all soundfile-specific errors.rNrrrrrrrrrrOrOes7rrOc\rSrSrSrSrg)riizGsoundfile module runtime error. Errors that used to be `RuntimeError`.rNrPrrrrris . rrc8\rSrSrSrSSjr\S5rSrSr g) riozVlibsndfile errors. Attributes ---------- code libsndfile internal error number. cH[RXU5 XlX lgr)rrcoder)rrTrs rrLibsndfileError.__init__xs&&t6:  rcUR(aE[RUR5n[R"U5R SS5$g)zRaw libsndfile error message.rrz'(Garbled error message from libsndfile))rTrsf_error_numberrr8r9)rerr_strs r error_stringLibsndfileError.error_string}s@ 99**4995G;;w'..w B B =rc4URUR-$r)rrYrs r__str__LibsndfileError.__str__s{{T....r)rTrNr<) rrrrrrrrYr\rrrrrros%  = =/rr) r!rNrzFNNNNNNNT)NNNTNN)Nrr!rNrzFNNNNNNNT)Fr)NNr^)Rr __version__osrsysrrrr ctypes.utilr _find_library _soundfilerrunicoder NameErrorr%rMr<r&r'rrrrr_machine_packaged_libnamer _architecturerr_soundfile_datardirname__file___pathr _full_pathdlopenr ImportErrorr_libname_explicit_libnameisdir _hbrew_pathr8sf_version_stringr9__libsndfile_version__ startswithrsrrrrRrrrrrrrrQrrrr6r#SFC_GET_FORMAT_INFOr,rrrr;rO RuntimeErrorrrrrrrzsF  ++5"H     X  X  X  X    X    X   X  X  X  X  X  X  X  X  X   X! " X# $        5 :#  f#  f#  f#  f #   f #   f #  f#  f#  f# f# f#  f# f# f# f#  f!# "f## $f%# &f'# (f)# *f+# ,f-# . f/# 0 f1# 2f3# 4 f5# 6 f7# 8f9# :f;# <f=# >f?# @fA# BfC# DfE#  L   X X X  X   X  X X X X X X X Y X  X!" X#$ X%&       5<     :2 }} 0)HJ6A ' !:0 ?1  ( 4  _Q 7 * 4 A!6-/8:>@ @ ' !0 :F F 5  - :U B =>> HH  _55 6Eu&78J ;;z "D<T%;%;%=>EEgyY$$]333C 4F4GHJO>B9=ZzEI=A6rFJBF%);?8v16V16h)F*D.$ 1 I[I[X2 @&60*.)A)AJ4  Y  NL /+/u2HJ i(22 +  TU U{{8$ 2 ==H $ 2  ]]g % 0  ]]g % /   1 ==H $w)>25((..AU2V2V.& ;;sxx}}[:KLMD;;01D'22sIL,3DL;,L87L8; P=%M--B1P9P="P94P=8P99P=