Документация Python неофициальный перевод

ossaudiodev.md

251 строк · 26.4 КБ · обычная страница · сырой текст · скачать

1> **Источник:** https://python-all.ru/3.8/library/ossaudiodev.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# [`ossaudiodev`](https://python-all.ru/3.8/library/ossaudiodev.html#module-ossaudiodev) – Доступ к аудиоустройствам, совместимым с OSS89---1011Этот модуль предоставляет доступ к аудиоинтерфейсу OSS (Open Sound System). OSS поддерживается многими системами Unix – как с открытым исходным кодом, так и коммерческими – и является стандартным аудиоинтерфейсом для Linux и последних версий FreeBSD.1213Изменено в версии 3.3: Операции в этом модуле теперь вызывают [`OSError`](https://python-all.ru/3.8/library/exceptions.html#OSError) вместо [`IOError`](https://python-all.ru/3.8/library/exceptions.html#IOError).1415> **См. также**16>17> **[Руководство программиста Open Sound System](https://python-all.ru/3.8/library/ossaudiodev.html)**18>19> официальная документация для OSS C API20>21> Модуль определяет большое количество констант, предоставляемых драйвером устройства OSS; список см. в `<sys/soundcard.h>` на Linux или FreeBSD.2223[`ossaudiodev`](https://python-all.ru/3.8/library/ossaudiodev.html#module-ossaudiodev) определяет следующие переменные и функции:2425#### `exception ossaudiodev.OSSAudioError`2627Это исключение вызывается при определенных ошибках. Аргументом является строка, описывающая, что пошло не так.2829(Если [`ossaudiodev`](https://python-all.ru/3.8/library/ossaudiodev.html#module-ossaudiodev) получает ошибку от системного вызова, такого как `open()`, `write()` или `ioctl()`, он вызывает [`OSError`](https://python-all.ru/3.8/library/exceptions.html#OSError). Ошибки, обнаруженные непосредственно [`ossaudiodev`](https://python-all.ru/3.8/library/ossaudiodev.html#module-ossaudiodev), приводят к [`OSSAudioError`](https://python-all.ru/3.8/library/ossaudiodev.html#ossaudiodev.OSSAudioError).)3031(Для обратной совместимости класс исключения также доступен как `ossaudiodev.error`.)3233#### `ossaudiodev.open(mode)`3435#### `ossaudiodev.open(device, mode)`3637Открывает аудиоустройство и возвращает объект аудиоустройства OSS. Этот объект поддерживает множество методов, похожих на файловые, таких как `read()`, `write()` и `fileno()` (хотя есть тонкие различия между традиционной семантикой чтения/записи Unix и семантикой аудиоустройств OSS). Он также поддерживает ряд специфических для аудио методов; полный список методов см. ниже.3839*device* – это имя файла аудиоустройства для использования. Если оно не указано, модуль сначала ищет в переменной окружения `AUDIODEV` устройство для использования. Если не найдено, используется `/dev/dsp`.4041*mode* – одно из значений: `'r'` для доступа только на чтение (запись), `'w'` для доступа только на запись (воспроизведение) и `'rw'` для обоих. Поскольку многие звуковые карты позволяют только одному процессу открыть записывающее или воспроизводящее устройство одновременно, рекомендуется открывать устройство только для требуемой операции. Кроме того, некоторые звуковые карты работают в полудуплексном режиме: их можно открыть для чтения или записи, но не для того и другого одновременно.4243Обратите внимание на необычный синтаксис вызова: *первый* аргумент необязателен, а второй обязателен. Это исторический артефакт для совместимости со старым модулем `linuxaudiodev`, который [`ossaudiodev`](https://python-all.ru/3.8/library/ossaudiodev.html#module-ossaudiodev) заменяет.4445#### `ossaudiodev.openmixer([device])`4647Открывает микшерное устройство и возвращает объект микшерного устройства OSS. *device* – это имя файла микшерного устройства для использования. Если оно не указано, модуль сначала ищет в переменной окружения `MIXERDEV` устройство для использования. Если не найдено, используется `/dev/mixer`.4849## Объекты аудиоустройств5051Перед записью или чтением с аудиоустройства необходимо вызвать три метода в правильном порядке:52531. `setfmt()` для установки формата вывода542. `channels()` для установки количества каналов553. `speed()` для установки частоты дискретизации5657В качестве альтернативы можно использовать метод `setparameters()`, чтобы установить все три аудиопараметра одновременно. Это удобнее, но может быть не таким гибким во всех случаях.5859Объекты аудиоустройств, возвращаемые [`open()`](https://python-all.ru/3.8/library/ossaudiodev.html#ossaudiodev.open), определяют следующие методы и (доступные только для чтения) атрибуты:6061#### `oss_audio_device.close()`6263Явно закрывает аудиоустройство. После завершения записи или чтения с аудиоустройства его следует явно закрыть. Закрытое устройство нельзя использовать повторно.6465#### `oss_audio_device.fileno()`6667Возвращает файловый дескриптор, связанный с устройством.6869#### `oss_audio_device.read(size)`7071Читает *size* байт из аудиовхода и возвращает их в виде строки Python. В отличие от большинства драйверов устройств Unix, аудиоустройства OSS в блокирующем режиме (по умолчанию) будут блокироваться [`read()`](https://python-all.ru/3.8/library/ossaudiodev.html#ossaudiodev.oss_audio_device.read) до тех пор, пока не станет доступен весь запрошенный объем данных.7273#### `oss_audio_device.write(data)`7475Записывает [объект, подобный байтам](https://python-all.ru/3.8/glossary.html#term-bytes-like-object) *data* в аудиоустройство и возвращает количество записанных байт. Если аудиоустройство находится в блокирующем режиме (по умолчанию), все данные всегда записываются (это отличается от обычной семантики устройств Unix). Если устройство находится в неблокирующем режиме, некоторые данные могут быть не записаны – см. [`writeall()`](https://python-all.ru/3.8/library/ossaudiodev.html#ossaudiodev.oss_audio_device.writeall).7677Изменено в версии 3.5: Теперь принимается записываемый [байтоподобный объект](https://python-all.ru/3.8/glossary.html#term-bytes-like-object).7879#### `oss_audio_device.writeall(data)`8081Записывает [объект, подобный байтам](https://python-all.ru/3.8/glossary.html#term-bytes-like-object) *data* в аудиоустройство: ждёт, пока устройство сможет принять данные, записывает столько, сколько оно готово принять, и повторяет, пока *data* не будет полностью записан. Если устройство находится в блокирующем режиме (по умолчанию), этот метод работает так же, как [`write()`](https://python-all.ru/3.8/library/ossaudiodev.html#ossaudiodev.oss_audio_device.write); [`writeall()`](https://python-all.ru/3.8/library/ossaudiodev.html#ossaudiodev.oss_audio_device.writeall) полезен только в неблокирующем режиме. Не возвращает значение, так как объём записанных данных всегда равен объёму переданных данных.8283Изменено в версии 3.5: Теперь принимается записываемый [байтоподобный объект](https://python-all.ru/3.8/glossary.html#term-bytes-like-object).8485Изменено в версии 3.2: Объекты аудиоустройств также поддерживают протокол контекстного менеджера, то есть их можно использовать в инструкции [`with`](https://python-all.ru/3.8/reference/compound_stmts.html#with).8687Следующие методы соответствуют ровно одному системному вызову `ioctl()`. Соответствие очевидно: например, `setfmt()` соответствует ioctl `SNDCTL_DSP_SETFMT`, а `sync()``SNDCTL_DSP_SYNC` (это может быть полезно при обращении к документации OSS). Если соответствующий `ioctl()` завершается ошибкой, все они вызывают [`OSError`](https://python-all.ru/3.8/library/exceptions.html#OSError).8889#### `oss_audio_device.nonblock()`9091Переводит устройство в неблокирующий режим. После перехода в неблокирующий режим вернуть его в блокирующий невозможно.9293#### `oss_audio_device.getfmts()`9495Возвращает битовую маску форматов аудиовыхода, поддерживаемых звуковой картой. Некоторые из форматов, поддерживаемых OSS:9697| Формат | Описание |98| --- | --- |99| `AFMT_MU_LAW` | логарифмическое кодирование (используется в файлах Sun `.au` и `/dev/audio`) |100| `AFMT_A_LAW` | логарифмическое кодирование |101| `AFMT_IMA_ADPCM` | сжатый формат 4:1, определённый Ассоциацией интерактивного мультимедиа |102| `AFMT_U8` | Беззнаковое 8-битное аудио |103| `AFMT_S16_LE` | Знаковое 16-битное аудио с порядком байтов от младшего к старшему (используется процессорами Intel) |104| `AFMT_S16_BE` | Знаковое 16-битное аудио с порядком байтов от старшего к младшему (используется 68k, PowerPC, Sparc) |105| `AFMT_S8` | Знаковое 8-битное аудио |106| `AFMT_U16_LE` | Беззнаковое 16-битное аудио с порядком от младшего к старшему |107| `AFMT_U16_BE` | Беззнаковое 16-битное аудио с порядком от старшего к младшему |108109Обратитесь к документации OSS за полным списком аудиоформатов и учтите, что большинство устройств поддерживают только подмножество этих форматов. Некоторые старые устройства поддерживают только `AFMT_U8`; наиболее распространённый формат, используемый сегодня, – `AFMT_S16_LE`.110111#### `oss_audio_device.setfmt(format)`112113Пытается установить текущий аудиоформат в *format* – см. список [`getfmts()`](https://python-all.ru/3.8/library/ossaudiodev.html#ossaudiodev.oss_audio_device.getfmts). Возвращает аудиоформат, который был установлен (может отличаться от запрошенного). Также может использоваться для получения текущего аудиоформата: для этого нужно передать «аудиоформат» `AFMT_QUERY`.114115#### `oss_audio_device.channels(nchannels)`116117Устанавливает количество выходных каналов в *nchannels*. Значение 1 означает монофонический звук, 2 – стереофонический. Некоторые устройства могут иметь более 2 каналов, а некоторые высококлассные устройства могут не поддерживать моно. Возвращает количество каналов, которое было установлено.118119#### `oss_audio_device.speed(samplerate)`120121Пытается установить частоту дискретизации аудио в *samplerate* отсчётов в секунду. Возвращает фактически установленную частоту. Большинство звуковых устройств не поддерживают произвольные частоты дискретизации. Распространённые частоты:122123| Частота | Описание |124| --- | --- |125| 8000 | частота по умолчанию для `/dev/audio` |126| 11025 | запись речи |127| 22050 |  |128| 44100 | аудио качества CD (16 бит/отсчёт, 2 канала) |129| 96000 | аудио качества DVD (24 бита/отсчёт) |130131#### `oss_audio_device.sync()`132133Ожидает, пока звуковое устройство воспроизведёт все байты из своего буфера. (Это происходит неявно при закрытии устройства.) В документации OSS рекомендуется закрывать и заново открывать устройство, а не использовать [`sync()`](https://python-all.ru/3.8/library/ossaudiodev.html#ossaudiodev.oss_audio_device.sync).134135#### `oss_audio_device.reset()`136137Немедленно останавливает воспроизведение или запись и возвращает устройство в состояние, в котором оно может принимать команды. Документация OSS рекомендует закрывать и заново открывать устройство после вызова [`reset()`](https://python-all.ru/3.8/library/ossaudiodev.html#ossaudiodev.oss_audio_device.reset).138139#### `oss_audio_device.post()`140141Уведомляет драйвер о вероятной паузе в выводе, чтобы устройство могло более разумно обработать эту паузу. Этот метод можно использовать после воспроизведения короткого звукового эффекта, перед ожиданием ввода от пользователя или перед выполнением дискового ввода-вывода.142143Следующие удобные методы объединяют несколько ioctl или один ioctl и несколько простых вычислений.144145#### `oss_audio_device.setparameters(format, nchannels, samplerate[, strict=False])`146147Устанавливает ключевые параметры аудио-дискретизации – формат сэмпла, количество каналов и частоту дискретизации – одним вызовом метода. *format*, *nchannels* и *samplerate* должны быть заданы так, как указано в методах [`setfmt()`](https://python-all.ru/3.8/library/ossaudiodev.html#ossaudiodev.oss_audio_device.setfmt), [`channels()`](https://python-all.ru/3.8/library/ossaudiodev.html#ossaudiodev.oss_audio_device.channels) и [`speed()`](https://python-all.ru/3.8/library/ossaudiodev.html#ossaudiodev.oss_audio_device.speed). Если *strict* равен true, [`setparameters()`](https://python-all.ru/3.8/library/ossaudiodev.html#ossaudiodev.oss_audio_device.setparameters) проверяет, был ли каждый параметр действительно установлен в запрошенное значение, и в противном случае вызывает [`OSSAudioError`](https://python-all.ru/3.8/library/ossaudiodev.html#ossaudiodev.OSSAudioError). Возвращает кортеж (*format*, *nchannels*, *samplerate*), показывающий значения параметров, которые были фактически установлены драйвером устройства (то есть те же, что возвращают [`setfmt()`](https://python-all.ru/3.8/library/ossaudiodev.html#ossaudiodev.oss_audio_device.setfmt), [`channels()`](https://python-all.ru/3.8/library/ossaudiodev.html#ossaudiodev.oss_audio_device.channels) и [`speed()`](https://python-all.ru/3.8/library/ossaudiodev.html#ossaudiodev.oss_audio_device.speed)).148149Например,150151```python152(fmt, channels, rate) = dsp.setparameters(fmt, channels, rate)153```154155эквивалентна156157```python158fmt = dsp.setfmt(fmt)159channels = dsp.channels(channels)160rate = dsp.rate(rate)161```162163#### `oss_audio_device.bufsize()`164165Возвращает размер аппаратного буфера в сэмплах.166167#### `oss_audio_device.obufcount()`168169Возвращает количество сэмплов, которые ещё находятся в аппаратном буфере и ожидают воспроизведения.170171#### `oss_audio_device.obuffree()`172173Возвращает количество сэмплов, которые можно поместить в аппаратный буфер для воспроизведения без блокировки.174175Объекты аудиоустройств также поддерживают несколько атрибутов только для чтения:176177#### `oss_audio_device.closed`178179Логическое значение, указывающее, было ли устройство закрыто.180181#### `oss_audio_device.name`182183Строка, содержащая имя файла устройства.184185#### `oss_audio_device.mode`186187Режим ввода-вывода файла: `"r"`, `"rw"` или `"w"`.188189## Объекты микшерных устройств190191Объект микшера предоставляет два метода, похожих на файловые:192193#### `oss_mixer_device.close()`194195Этот метод закрывает открытый файл микшерного устройства. Любые дальнейшие попытки использовать микшер после закрытия этого файла вызовут исключение [`OSError`](https://python-all.ru/3.8/library/exceptions.html#OSError).196197#### `oss_mixer_device.fileno()`198199Возвращает номер файлового дескриптора открытого файла микшерного устройства.200201Изменено в версии 3.2: Объекты микшера также поддерживают протокол менеджера контекста.202203Оставшиеся методы относятся к аудио-микшированию:204205#### `oss_mixer_device.controls()`206207Этот метод возвращает битовую маску, описывающую доступные элементы управления микшера («элемент управления» – это конкретный микшируемый «канал», например `SOUND_MIXER_PCM` или `SOUND_MIXER_SYNTH`). Эта битовая маска указывает подмножество всех доступных элементов управления микшера – констант `SOUND_MIXER_*`, определённых на уровне модуля. Чтобы определить, например, поддерживает ли текущий объект микшера микшер PCM, используйте следующий код Python:208209```python210mixer=ossaudiodev.openmixer()211if mixer.controls() & (1 << ossaudiodev.SOUND_MIXER_PCM):212    # PCM поддерживается213    ... code ...214```215216Для большинства целей достаточно элементов управления `SOUND_MIXER_VOLUME` (общая громкость) и `SOUND_MIXER_PCM`, но код, использующий микшер, должен быть гибким в выборе элементов управления. Например, на Gravis Ultrasound `SOUND_MIXER_VOLUME` не существует.217218#### `oss_mixer_device.stereocontrols()`219220Возвращает битовую маску, указывающую стереорегуляторы микшера. Если бит установлен, соответствующий регулятор стереофонический; если сброшен – регулятор либо монофонический, либо не поддерживается микшером (используйте вместе с [`controls()`](https://python-all.ru/3.8/library/ossaudiodev.html#ossaudiodev.oss_mixer_device.controls), чтобы определить).221222Пример получения данных из битовой маски см. в примере для функции [`controls()`](https://python-all.ru/3.8/library/ossaudiodev.html#ossaudiodev.oss_mixer_device.controls).223224#### `oss_mixer_device.reccontrols()`225226Возвращает битовую маску, определяющую регуляторы микшера, которые можно использовать для записи. Пример чтения битовой маски см. в примере для [`controls()`](https://python-all.ru/3.8/library/ossaudiodev.html#ossaudiodev.oss_mixer_device.controls).227228#### `oss_mixer_device.get(control)`229230Возвращает громкость указанного регулятора микшера. Возвращаемая громкость – это кортеж из двух элементов `(left_volume,right_volume)`. Громкость задаётся числами от 0 (тишина) до 100 (максимальная громкость). Если регулятор монофонический, всё равно возвращается кортеж из двух элементов, но оба значения громкости одинаковы.231232Возбуждает [`OSSAudioError`](https://python-all.ru/3.8/library/ossaudiodev.html#ossaudiodev.OSSAudioError), если указан недопустимый регулятор, или [`OSError`](https://python-all.ru/3.8/library/exceptions.html#OSError), если указан неподдерживаемый регулятор.233234#### `oss_mixer_device.set(control, (left, right))`235236Устанавливает громкость указанного регулятора микшера в значение `(left,right)`. `left` и `right` должны быть целыми числами от 0 (тишина) до 100 (максимальная громкость). В случае успеха возвращается новый уровень громкости в виде кортежа из двух элементов. Обратите внимание: он может не совпадать с указанным значением из-за ограниченного разрешения микшера некоторых звуковых карт.237238Возбуждает [`OSSAudioError`](https://python-all.ru/3.8/library/ossaudiodev.html#ossaudiodev.OSSAudioError), если указан недопустимый регулятор микшера или заданные значения громкости выходят за допустимый диапазон.239240#### `oss_mixer_device.get_recsrc()`241242Этот метод возвращает битовую маску, указывающую, какие регуляторы в данный момент используются как источник записи.243244#### `oss_mixer_device.set_recsrc(bitmask)`245246Вызовите эту функцию, чтобы указать источник записи. В случае успеха возвращает битовую маску, указывающую новый источник (или источники) записи; возбуждает [`OSError`](https://python-all.ru/3.8/library/exceptions.html#OSError), если указан недопустимый источник. Чтобы установить текущий источник записи на микрофонный вход:247248```python249mixer.setrecsrc (1 << ossaudiodev.SOUND_MIXER_MIC)250```251