mirrors/pulseaudio
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pulseaudio/pulseaudio.git synced 2025-10-29 05:40:23 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
pulseaudio/PROTOCOL

359 lines
7.7 KiB
Text
Raw Normal View History

add short version history of the PA protocol git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@2065 fefdeb5f-60dc-0310-8127-8f9354f1896f
2007-11-21 01:21:00 +00:00
### v8, implemented by >= 0.8
First version supported.
### v9, implemented by >= 0.9.0
Reply for PA_COMMAND_CREATE_PLAYBACK_STREAM,
PA_COMMAND_CREATE_RECORD_STREAM now returns buffer_attrs that are used:
Four new fields in reply of PA_COMMAND_CREATE_PLAYBACK_STREAM:
maxlength
tlength
prebuf
minreq
Two new fields in reply of PA_COMMAND_CREATE_RECORD_STREAM:
maxlength
fragsize
### v10, implemented by >= 0.9.5
New opcodes:
PA_COMMAND_MOVE_SINK_INPUT
PA_COMMAND_MOVE_SOURCE_OUTPUT
SHM data transfer support
### v11, implemented by >= 0.9.7
Reply to to PA_COMMAND_GET_SINK_INPUT_INFO, PA_COMMAND_GET_SINK_INPUT_INFO_LIST gets new field at the end:
mute
New opcodes:
PA_COMMAND_SET_SINK_INPUT_MUTE
PA_COMMAND_SUSPEND_SINK
PA_COMMAND_SUSPEND_SOURCE
### v12, implemented by >= 0.9.8
S32LE, S32BE is now known as sample spec.
Gained six new bool fields for PA_COMMAND_CREATE_PLAYBACK_STREAM, PA_COMMAND_CREATE_RECORD_STREAM request at the end:
no_remap_channels
no_remix_channels
fix_format
fix_rate
fix_channels
no_move
variable_rate
Reply to these opcodes now includes:
sample_spec
channel_map
device_index
device_name
suspended
New opcodes for changing buffer attrs:
PA_COMMAND_SET_PLAYBACK_STREAM_BUFFER_ATTR
PA_COMMAND_SET_RECORD_STREAM_BUFFER_ATTR
New opcodes for changing sampling rate:
PA_COMMAND_UPDATE_PLAYBACK_STREAM_SAMPLE_RATE
PA_COMMAND_UPDATE_RECORD_STREAM_SAMPLE_RATE
New opcodes for notifications:
PA_COMMAND_PLAYBACK_STREAM_SUSPENDED
PA_COMMAND_CAPTURE_STREAM_SUSPENDED
PA_COMMAND_PLAYBACK_STREAM_MOVED
PA_COMMAND_CAPTURE_STREAM_MOVED
merge glitch-free branch back into trunk git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@2445 fefdeb5f-60dc-0310-8127-8f9354f1896f
2008-05-15 23:34:41 +00:00
add extension system for native protocol
2008-08-03 18:56:10 +02:00
### v13, implemented by >= 0.9.11
merge glitch-free branch back into trunk git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@2445 fefdeb5f-60dc-0310-8127-8f9354f1896f
2008-05-15 23:34:41 +00:00
New fields for PA_COMMAND_CREATE_PLAYBACK_STREAM, PA_COMMAND_CREATE_RECORD_STREAM request at the end:
peak_detect (bool)
also update PROTOCOL git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@2446 fefdeb5f-60dc-0310-8127-8f9354f1896f
2008-05-15 23:36:44 +00:00
adjust_latency (bool)
merge glitch-free branch back into trunk git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@2445 fefdeb5f-60dc-0310-8127-8f9354f1896f
2008-05-15 23:34:41 +00:00
Replace field "name" for PA_COMMAND_CREATE_PLAYBACK_STREAM, PA_COMMAND_CREATE_RECORD_STREAM at the end:
proplist
Replace field "name" for PA_COMMAND_SET_CLIENT_NAME request at the end:
proplist
On response of PA_COMMAND_SET_CLIENT_NAME:
client_index
New proplist field for sink, source, sink input, source output introspection opcodes and at the end:
proplist
New opcodes for proplist modifications
PA_COMMAND_UPDATE_RECORD_STREAM_PROPLIST
PA_COMMAND_UPDATE_PLAYBACK_STREAM_PROPLIST
PA_COMMAND_UPDATE_CLIENT_PROPLIST
PA_COMMAND_REMOVE_RECORD_STREAM_PROPLIST
PA_COMMAND_REMOVE_PLAYBACK_STREAM_PROPLIST
PA_COMMAND_REMOVE_CLIENT_PROPLIST
New field for PA_COMMAND_PLAY_SAMPLE:
proplist
New field for PA_COMMAND_PLAY_SAMPLE response:
idx
New field for PA_COMMAND_CREATE_PLAYBACK_STREAM at the end:
start_muted
Buffer attributes for PA_COMMAND_CREATE_PLAYBACK_STREAM and
PA_COMMAND_CREATE_RECORD_STREAM may now be 0 for default values.
also update PROTOCOL git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@2446 fefdeb5f-60dc-0310-8127-8f9354f1896f
2008-05-15 23:36:44 +00:00
Implement "early requests" mode. PA_STREAM_EARLY_REQUESTS is a new flag that will modify buffering metric selection behaviour a bit. This code is good for broken ALSA/OSS clients that ignore 'readability' on the fds in question and schedule audio via usleep() instead.
2008-09-03 18:31:46 +02:00
New field for PA_COMMAND_SET_PLAYBACK_STREAM_BUFFER_ATTR,
also update PROTOCOL git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@2446 fefdeb5f-60dc-0310-8127-8f9354f1896f
2008-05-15 23:36:44 +00:00
PA_COMMAND_SET_RECORD_STREAM_BUFFER_ATTR at the end:
adjust_latency (bool)
new message:
PA_COMMAND_STARTED
add extension system for native protocol
2008-08-03 18:56:10 +02:00
### v14, implemented by >= 0.9.12
new message:
PA_COMMAND_EXTENSION
allow clients to not specify the volume for their streams
2008-08-18 17:49:18 +02:00
Implement "early requests" mode. PA_STREAM_EARLY_REQUESTS is a new flag that will modify buffering metric selection behaviour a bit. This code is good for broken ALSA/OSS clients that ignore 'readability' on the fds in question and schedule audio via usleep() instead.
2008-09-03 18:31:46 +02:00
PA_COMMAND_CREATE_PLAYBACK_STREAM:
allow clients to not specify the volume for their streams
2008-08-18 17:49:18 +02:00
bool volume_set at the end
Implement "early requests" mode. PA_STREAM_EARLY_REQUESTS is a new flag that will modify buffering metric selection behaviour a bit. This code is good for broken ALSA/OSS clients that ignore 'readability' on the fds in question and schedule audio via usleep() instead.
2008-09-03 18:31:46 +02:00
PA_COMMAND_CREATE_RECORD_STREAM, PA_COMMAND_CREATE_PLAYBACK_STREAM:
bool early_requests at the end
New field for PA_COMMAND_SET_PLAYBACK_STREAM_BUFFER_ATTR,
PA_COMMAND_SET_RECORD_STREAM_BUFFER_ATTR at the end:
early_requests (bool)
Implement new flags DONT_INHIBIT_AUTO_SUSPEND and START_UNMUTED
2008-10-26 19:32:04 +01:00
fix version info in protocol history
2009-01-16 03:13:42 +01:00
### v15, implemented by >= 0.9.15
Implement new flags DONT_INHIBIT_AUTO_SUSPEND and START_UNMUTED
2008-10-26 19:32:04 +01:00
PA_COMMAND_CREATE_PLAYBACK_STREAM
bool muted at the end
PA_COMMAND_CREATE_PLAYBACK_STREAM, PA_COMMAND_CREATE_RECORD_STREAM:
allow setting properties for modules, too
2009-01-19 22:02:28 +01:00
bool dont_inhibit_auto_suspend at the end
PA_COMMAND_GET_MODULE_INFO_LIST
remove bool auto_unload
add proplist at the end
notify clients about tlength changes
2009-03-30 18:46:12 +02:00
new messages:
PA_COMMAND_GET_CARD_INFO
PA_COMMAND_GET_CARD_INFO_LIST
PA_COMMAND_SET_CARD_PROFILE
PA_COMMAND_CLIENT_EVENT
PA_COMMAND_PLAYBACK_STREAM_EVENT
PA_COMMAND_RECORD_STREAM_EVENT
PA_COMMAND_PLAYBACK_BUFFER_ATTR_CHANGED
PA_COMMAND_RECORD_BUFFER_ATTR_CHANGED
libpulse: implement client side for sink/source port selection commands
2009-06-17 04:54:11 +02:00
### v16, implemented by >= 0.9.15
new messages:
PA_COMMAND_SET_SINK_PORT
PA_COMMAND_SET_SOURCE_PORT
libpulse: introduce PA_STREAM_RELATIVE_VOLUME
2009-10-29 00:46:22 +01:00
## v17, implemented by >= 0.9.20
new flag at end of CREATE_PLAYBACK_STREAM:
bool relative_volume
AC3 passthrough support Second version after Tanu's feedback TODO: - notify client that volume control is disabled - change sink rate in passthrough mode if needed - automatic detection of passthrough mode instead of hard coded profile names Signed-off-by: Pierre-Louis Bossart <pierre-louis.bossart@intel.com>
2010-07-16 16:46:28 -05:00
## v18, implemented by >= 0.9.22
new flag at end of CREATE_PLAYBACK_STREAM:
bool passthrough
introspect: Include whether a stream is corked in the info callback.
2010-10-04 11:48:43 +01:00
## v19, implemented by >= 0.9.22
Allow read-only or non-existing sink input volume. There are two known cases where read-only or non-existing sink input volume is relevant: passthrough streams and the planned volume sharing logic. Passthrough streams don't have volume at all, and the volume sharing logic requires read-only sink input volume. This commit is primarily working towards the volume sharing feature, but support for non-existing sink input volume is also added, because it is so closely related to read-only volume. Some unrelated refactoring in iface-stream.c creeped into this commit too (new function: stream_to_string()).
2011-02-14 13:41:06 +02:00
New flag at the end of sink input and source output introspection data:
introspect: Include whether a stream is corked in the info callback.
2010-10-04 11:48:43 +01:00
bool corked
Allow read-only or non-existing sink input volume. There are two known cases where read-only or non-existing sink input volume is relevant: passthrough streams and the planned volume sharing logic. Passthrough streams don't have volume at all, and the volume sharing logic requires read-only sink input volume. This commit is primarily working towards the volume sharing feature, but support for non-existing sink input volume is also added, because it is so closely related to read-only volume. Some unrelated refactoring in iface-stream.c creeped into this commit too (new function: stream_to_string()).
2011-02-14 13:41:06 +02:00
## v20, implemented by >= 1.0
Two new flags at the end of sink input introspection data:
bool has_volume
sink-input: Add volume_writable to pa_sink_input. This is pretty cosmetic change; there's no actual functionality added. Previously the volume_writable information was available through the pa_sink_input_is_volume_writable() function, but I find it cleaner to have a real variable. The sink input introspection variable name was also changed from read_only_volume to volume_writable for consistency.
2011-03-27 23:00:26 +03:00
bool volume_writable
core: Add extended stream API to support compressed formats This is the beginning of work to support compressed formats natively in PulseAudio. This adds a pa_stream_new_extended() that takes a format structure, sends it to the server (=> protocol extension) and has the server negotiate with the appropropriate sink to figure out what format it should use. This is work in progress, and works only with PCM streams. Actual compressed format support in some sink needs to be implemented, and extensive testing is required. More details on how this is supposed to work is available at: http://pulseaudio.org/wiki/PassthroughSupport
2011-02-28 13:23:23 +05:30
## v21, implemented by >= 1.0
Changes for format negotiation in the extended API.
New fields PA_COMMAND_CREATE_PLAYBACK_STREAM:
uint8_t n_formats
format_info format1
...
format_info formatn
One new field in reply from PA_COMMAND_CREATE_PLAYBACK_STREAM:
format_info format
introspect: Get formats for sinks This gets the list of supported formats for a sink in pa_context_get_sink_info*(). Also prints these in 'pactl list'.
2011-03-08 23:30:24 +05:30
New fields in reply from PA_COMMAND_GET_SINK_INFO (and thus
PA_COMMAND_GET_SINK_INFO_LIST)
uint8_t n_formats
format_info format1
...
format_info formatn
introspect: Get format of sink input This gets the negotiated format of sink inputs in pa_context_get_sink_input*(). Also prints the format in 'pactl list'.
2011-03-08 23:31:59 +05:30
One new field in reply from PA_COMMAND_GET_SINK_INPUT_INFO (and thus
PA_COMMAND_GET_SINK_INPUT_INFO_LIST)
format_info format
capture: Add the passthrough format negotiation to capture streams. This helps to keep the API more symmetrical and also potentially allows support for passthrough monitor sources at some point in the future.
2011-05-17 21:56:10 +01:00
## v22, implemented by >= 1.0
New fields PA_COMMAND_CREATE_RECORD_STREAM:
uint8_t n_formats
format_info format1
...
format_info formatn
PROTOCOL: Fix documentation for version 22 Fix the documentation: the protocol file was not reflecting the code properly for version 22. Signed-off-by: David Henningsson <david.henningsson@canonical.com>
2012-01-30 16:47:53 +01:00
volume
bool muted
bool volume_set
bool muted_set
bool relative_volume
bool passthrough
capture: Add the passthrough format negotiation to capture streams. This helps to keep the API more symmetrical and also potentially allows support for passthrough monitor sources at some point in the future.
2011-05-17 21:56:10 +01:00
One new field in reply from PA_COMMAND_CREATE_RECORD_STREAM:
format_info format
introspect: Get formats for sources This gets the list of supported formats for a source in pa_context_get_source_info*(). Also prints these in 'pactl list'.
2011-05-16 22:15:57 +01:00
New fields in reply from PA_COMMAND_GET_SOURCE_INFO (and thus
PA_COMMAND_GET_SOURCE_INFO_LIST)
uint8_t n_formats
format_info format1
...
format_info formatn
capture: Implement per-stream volume control for capture streams. This piggy backs onto the previous changes for protocol 22 and thus does not bump the version. This and the previous commits should be seen as mostly atomic. Apologies for any bisecting issues this causes (although I would expect these to be minimal)
2011-05-17 22:31:10 +01:00
introspect: Get format of source output This gets the negotiated format of source outputs in pa_context_get_source_output*(). Also prints the format and volume in 'pactl list'.
2011-05-16 22:23:24 +01:00
Five new fields in reply from PA_COMMAND_GET_SOURCE_OUTPUT_INFO (and thus
capture: Implement per-stream volume control for capture streams. This piggy backs onto the previous changes for protocol 22 and thus does not bump the version. This and the previous commits should be seen as mostly atomic. Apologies for any bisecting issues this causes (although I would expect these to be minimal)
2011-05-17 22:31:10 +01:00
PA_COMMAND_GET_SOURCE_OUTPUT_INFO_LIST)
volume
bool mute
bool has_volume
bool volume_writable
PROTOCOL: Fix documentation for version 22 Fix the documentation: the protocol file was not reflecting the code properly for version 22. Signed-off-by: David Henningsson <david.henningsson@canonical.com>
2012-01-30 16:47:53 +01:00
format_info format
Document PA_COMMAND_UNDERFLOW protocol change Signed-off-by: David Henningsson <david.henningsson@canonical.com>
2011-08-04 10:33:54 +02:00
## v23, implemented by >= 1.0
New field in PA_COMMAND_UNDERFLOW:
int64_t index
Remind people not to break module-tunnel
2011-08-15 15:19:10 +05:30
Introduce "available" concept for ports, and communicate that to clients. Bump protocol version to 24. Note: There is still no notification when status availability changes. Signed-off-by: David Henningsson <david.henningsson@canonical.com>
2011-11-25 15:17:11 +01:00
## v24, implemented by >= 2.0
New field in all commands that send/receive port introspection data
Fix a copy-paste error in PROTOCOL.
2012-04-13 14:31:44 +03:00
(PA_COMMAND_GET_(SOURCE|SINK)_INFO,
PA_COMMAND_GET_(SOURCE|SINK)_INFO_LIST):
Introduce "available" concept for ports, and communicate that to clients. Bump protocol version to 24. Note: There is still no notification when status availability changes. Signed-off-by: David Henningsson <david.henningsson@canonical.com>
2011-11-25 15:17:11 +01:00
uint32_t available
The field is added once for every port.
Notify port available status changes, and update protocol version The recommended way of setting available status is to call pa_device_port_set_available, which will send a subscription event to the relevant card. It will also fire a hook. Signed-off-by: David Henningsson <david.henningsson@canonical.com>
2011-11-25 15:17:14 +01:00
## v25, implemented by >= 2.0
When port availability changes, send a subscription event for the
owning card.
introspect: Expose port info per card to clients For volume control UIs to be able to show ports in inactive profiles, expose all ports together with the card info. This includes updating the protocol and the client API to show the connection between ports and for which profiles the ports are relevant. Update protocol to 26. Signed-off-by: David Henningsson <david.henningsson@canonical.com>
2012-02-23 07:17:06 +01:00
## v26, implemented by >= 2.0
In reply from PA_COMMAND_GET_CARD_INFO (and thus
PA_COMMAND_GET_CARD_INFO_LIST), the following is added:
uint32_t n_ports
...followed by n_ports extended port entries, which look like this:
string name
string description
uint32_t priority
uint32_t available
uint8_t direction
proplist
uint32_t n_profiles
string profile_name_1
...
string profile_name_n
Profile names must match earlier sent profile names for the same card.
introspect: Add functions to handle the latency offset. This includes updating the native protocol and the client API. A new command was added to allow setting the latency offset. Also the card list command now shows the latency offset if there are ports available. Update protocol to 27.
2012-06-28 15:00:45 +02:00
## v27, implemented by >= 3.0
New opcodes:
PA_COMMAND_SET_PORT_LATENCY_OFFSET
New field in the card commands that send/receive port introspection data
PA_COMMAND_GET_CARD_INFO(_LIST)):
int64_t latency_offset
The field is added once for every port.
introspect: Expose port info per card to clients For volume control UIs to be able to show ports in inactive profiles, expose all ports together with the card info. This includes updating the protocol and the client API to show the connection between ports and for which profiles the ports are relevant. Update protocol to 26. Signed-off-by: David Henningsson <david.henningsson@canonical.com>
2012-02-23 07:17:06 +01:00
Bump the native protocol version The previous AAC pass-through patch (commit: 53807e4a) introduced a new encoding format type: PA_ENCODING_MPEG2_AAC_IEC61937, which is mostly used in pa_format_info, but forgot to increment the protocol version number. The version needs to be incremented, because clients need some way of checking whether the server supports the new encoding.
2013-02-25 01:01:05 +09:00
## v28, implemented by >= 4.0
New value for encoding format type in format_info
PA_COMMAND_CREATE_(PLAYBACK|RECORDING)_STREAM and its reply,
In reply from PA_COMMAND_GET_(SOURCE|SOURCE_OUTPUT|SINK|SINK_INPUT)_INFO[_LIST],
SUBCOMMAND_SAVE_FORMATS, in reply from SUBCOMMAND_READ_FORMATS[_ALL]
(uint8_t ) PA_ENCODING_MPEG2_AAC_IEC61937 := 6
introspect: Expose card profile available flag Available flag can be used by clients to disable the selection of profiles unavailable. Update protocol to 29
2013-07-15 18:21:25 +03:00
## v29, implemented by >= 5.0
#
New field in all commands that send/receive profile introspection data
(PA_COMMAND_GET_CARD_INFO)
uint32 available
The field is added once for every profile.
Remind people not to break module-tunnel
2011-08-15 15:19:10 +05:30
#### If you just changed the protocol, read this
## module-tunnel depends on the sink/source/sink-input/source-input protocol
## internals, so if you changed these, you might have broken module-tunnel.
## Don't forget to test module-tunnel-{source,sink} when pushing protocol
## changes.
Reference in a new issue Copy permalink