pa-ringbuffer 0.1.4

用法

此模块不应单独使用，它仅在与使用CFFI的另一个Python模块合作时才有用。例如，请参阅https://github.com/spatialaudio/python-rtmixer。

您可以从PyPI获取Python代码，例如在您的setup.py文件中（在以下示例中，您的模块将被命名为mycffimodule）

from setuptools import setup

setup(
    name=...,
    version=...,
    author=...,
    ...,
    cffi_modules=['mycffimodule_build.py:ffibuilder'],
    setup_requires=['CFFI', 'pa_ringbuffer'],
    install_requires=['pa_ringbuffer'],
    ...,
)

或者，您可以直接将文件src/pa_ringbuffer.py复制到您自己的源目录中，并从中导入它。

您可以根据http://cffi.readthedocs.io/en/latest/cdef.html中的说明构建自己的CFFI模块，只需在mycffimodule_build.py中添加一些额外的代码即可。

from cffi import FFI
import pa_ringbuffer

ffibuilder = FFI()
ffibuilder.cdef(pa_ringbuffer.cdef())
ffibuilder.cdef("""

/* my own declarations */

""")
ffibuilder.set_source(
    '_mycffimodule',
    '/* my implementation */',
    sources=['portaudio/src/common/pa_ringbuffer.c'],
)

if __name__ == '__main__':
    ffibuilder.compile(verbose=True)

请注意，以下文件必须对编译器可用

• https://app.assembla.com/spaces/portaudio/git/source/master/src/common/pa_ringbuffer.c

• https://app.assembla.com/spaces/portaudio/git/source/master/src/common/pa_ringbuffer.h

• https://app.assembla.com/spaces/portaudio/git/source/master/src/common/pa_memorybarrier.h

对于您自己的C代码，您可能需要从主PortAudio头文件中获取一些定义

• https://app.assembla.com/spaces/portaudio/git/source/master/include/portaudio.h

一旦您编译了您的扩展模块（在CFFI的帮助下），您可以在自己的模块中使用以下内容来获取对RingBuffer类的访问权限

import pa_ringbuffer
from _mycffimodule import ffi, lib

RingBuffer = pa_ringbuffer.init(ffi, lib)

API参考

只有两个函数

创建文档

RingBuffer类的文档不单独提供。如果您使用Sphinx，您可以无缝地将RingBuffer类的文档包含到您的文档中。一个示例可以在https://github.com/spatialaudio/python-rtmixer找到，生成的文档可在http://python-rtmixer.readthedocs.io/#rtmixer.RingBuffer找到。

您需要激活autodoc扩展在您的conf.py

extensions = [
    ...,
    'sphinx.ext.autodoc',
    ...,
]

在模块文档中，您应该添加以下内容

.. autoclass:: RingBuffer
   :inherited-members:

在此之前，您可能需要使用currentmodule指令来选择您自己的模块。使用automodule也应该可以。

如果您想使用Sphinx的nitpicky设置，您必须向nitpick_ignore添加一些内容

nitpicky = True
nitpick_ignore = [
    ('py:class', 'optional'),
    ('py:class', 'buffer'),
    ('py:class', 'CData pointer'),
]

版本历史

0.1.4 (2020-08-27):

• 次要文档更新

0.1.3 (2018-06-02):

• 没有新功能，只是次要的文档更新

0.1.2 (2017-10-21):

• 没有新功能，只是修复了错误

0.1.1 (2017-09-04):

• 添加buffer参数

0.1.0 (2017-08-08):

初始版本