PulseAudio  6.0
stream.h
Go to the documentation of this file.
1 #ifndef foostreamhfoo
2 #define foostreamhfoo
3 
4 /***
5  This file is part of PulseAudio.
6 
7  Copyright 2004-2006 Lennart Poettering
8  Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
9 
10  PulseAudio is free software; you can redistribute it and/or modify
11  it under the terms of the GNU Lesser General Public License as published
12  by the Free Software Foundation; either version 2.1 of the License,
13  or (at your option) any later version.
14 
15  PulseAudio is distributed in the hope that it will be useful, but
16  WITHOUT ANY WARRANTY; without even the implied warranty of
17  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18  General Public License for more details.
19 
20  You should have received a copy of the GNU Lesser General Public License
21  along with PulseAudio; if not, see <http://www.gnu.org/licenses/>.
22 ***/
23 
24 #include <sys/types.h>
25 
26 #include <pulse/sample.h>
27 #include <pulse/format.h>
28 #include <pulse/channelmap.h>
29 #include <pulse/volume.h>
30 #include <pulse/def.h>
31 #include <pulse/cdecl.h>
32 #include <pulse/operation.h>
33 #include <pulse/context.h>
34 #include <pulse/proplist.h>
35 
332 PA_C_DECL_BEGIN
333 
335 typedef struct pa_stream pa_stream;
336 
338 typedef void (*pa_stream_success_cb_t) (pa_stream*s, int success, void *userdata);
339 
341 typedef void (*pa_stream_request_cb_t)(pa_stream *p, size_t nbytes, void *userdata);
342 
344 typedef void (*pa_stream_notify_cb_t)(pa_stream *p, void *userdata);
345 
352 typedef void (*pa_stream_event_cb_t)(pa_stream *p, const char *name, pa_proplist *pl, void *userdata);
353 
358  pa_context *c ,
359  const char *name ,
360  const pa_sample_spec *ss ,
361  const pa_channel_map *map );
362 
367  pa_context *c ,
368  const char *name ,
369  const pa_sample_spec *ss ,
370  const pa_channel_map *map ,
371  pa_proplist *p );
372 
378  pa_context *c ,
379  const char *name ,
380  pa_format_info * const * formats ,
381  unsigned int n_formats ,
382  pa_proplist *p );
383 
385 void pa_stream_unref(pa_stream *s);
386 
389 
392 
395 
400 uint32_t pa_stream_get_index(pa_stream *s);
401 
412 
422 const char *pa_stream_get_device_name(pa_stream *s);
423 
429 
433 
459  pa_stream *s ,
460  const char *dev ,
461  const pa_buffer_attr *attr ,
462  pa_stream_flags_t flags ,
463  const pa_cvolume *volume ,
464  pa_stream *sync_stream );
465 
468  pa_stream *s ,
469  const char *dev ,
470  const pa_buffer_attr *attr ,
471  pa_stream_flags_t flags );
472 
475 
509  pa_stream *p,
510  void **data,
511  size_t *nbytes);
512 
523  pa_stream *p);
524 
547 int pa_stream_write(
548  pa_stream *p ,
549  const void *data ,
550  size_t nbytes ,
551  pa_free_cb_t free_cb ,
552  int64_t offset,
553  pa_seek_mode_t seek );
554 
558  pa_stream *p ,
559  const void *data ,
560  size_t nbytes ,
561  pa_free_cb_t free_cb ,
562  void *free_cb_data ,
563  int64_t offset ,
564  pa_seek_mode_t seek );
565 
582 int pa_stream_peek(
583  pa_stream *p ,
584  const void **data ,
585  size_t *nbytes );
586 
589 int pa_stream_drop(pa_stream *p);
590 
593 
596 
602 
608 
611 
615 
618 
621 
627 
630 
637 
642 
649 
659 
662 void pa_stream_set_event_callback(pa_stream *p, pa_stream_event_cb_t cb, void *userdata);
663 
670 
681 pa_operation* pa_stream_cork(pa_stream *s, int b, pa_stream_success_cb_t cb, void *userdata);
682 
687 
691 
696 
698 pa_operation* pa_stream_set_name(pa_stream *s, const char *name, pa_stream_success_cb_t cb, void *userdata);
699 
731 int pa_stream_get_time(pa_stream *s, pa_usec_t *r_usec);
732 
745 int pa_stream_get_latency(pa_stream *s, pa_usec_t *r_usec, int *negative);
746 
762 
765 
768 
771 
781 
791 
797 pa_operation *pa_stream_update_sample_rate(pa_stream *s, uint32_t rate, pa_stream_success_cb_t cb, void *userdata);
798 
806 
809 pa_operation *pa_stream_proplist_remove(pa_stream *s, const char *const keys[], pa_stream_success_cb_t cb, void *userdata);
810 
815 int pa_stream_set_monitor_stream(pa_stream *s, uint32_t sink_input_idx);
816 
821 
822 PA_C_DECL_END
823 
824 #endif
struct pa_context pa_context
An opaque connection context to a daemon.
Definition: context.h:154
int pa_stream_write_ext_free(pa_stream *p, const void *data, size_t nbytes, pa_free_cb_t free_cb, void *free_cb_data, int64_t offset, pa_seek_mode_t seek)
Function does exactly the same as pa_stream_write() with the difference that free_cb_data is passed t...
int pa_stream_is_corked(pa_stream *s)
Return 1 if the this stream has been corked.
void(* pa_stream_request_cb_t)(pa_stream *p, size_t nbytes, void *userdata)
A generic request callback.
Definition: stream.h:341
A sample format and attribute specification.
Definition: sample.h:248
const char * pa_stream_get_device_name(pa_stream *s)
Return the name of the sink or source this stream is connected to in the server.
Connection contexts for asynchronous communication with a server.
enum pa_stream_state pa_stream_state_t
The state of a stream.
void(* pa_free_cb_t)(void *p)
A generic free() like callback prototype.
Definition: def.h:1014
void pa_stream_set_overflow_callback(pa_stream *p, pa_stream_notify_cb_t cb, void *userdata)
Set the callback function that is called when a buffer overflow happens.
pa_stream * pa_stream_ref(pa_stream *s)
Increase the reference counter by one.
Global definitions.
Constants and routines for volume handling.
void pa_stream_set_underflow_callback(pa_stream *p, pa_stream_notify_cb_t cb, void *userdata)
Set the callback function that is called when a buffer underflow happens.
int pa_stream_write(pa_stream *p, const void *data, size_t nbytes, pa_free_cb_t free_cb, int64_t offset, pa_seek_mode_t seek)
Write some data to the server (for playback streams).
int pa_stream_get_latency(pa_stream *s, pa_usec_t *r_usec, int *negative)
Determine the total stream latency.
pa_stream_state_t pa_stream_get_state(pa_stream *p)
Return the current state of the stream.
int pa_stream_set_monitor_stream(pa_stream *s, uint32_t sink_input_idx)
For record streams connected to a monitor source: monitor only a very specific sink input of the sink...
const pa_sample_spec * pa_stream_get_sample_spec(pa_stream *s)
Return a pointer to the stream's sample specification.
pa_operation * pa_stream_set_buffer_attr(pa_stream *s, const pa_buffer_attr *attr, pa_stream_success_cb_t cb, void *userdata)
Change the buffer metrics of the stream during playback.
A structure encapsulating a per-channel volume.
Definition: volume.h:148
pa_operation * pa_stream_update_sample_rate(pa_stream *s, uint32_t rate, pa_stream_success_cb_t cb, void *userdata)
Change the stream sampling rate during playback.
int pa_stream_peek(pa_stream *p, const void **data, size_t *nbytes)
Read the next fragment from the buffer (for recording streams).
void pa_stream_set_suspended_callback(pa_stream *p, pa_stream_notify_cb_t cb, void *userdata)
Set the callback function that is called whenever the sink/source this stream is connected to is susp...
int64_t pa_stream_get_underflow_index(pa_stream *p)
Return at what position the latest underflow occurred, or -1 if this information is not known (e...
pa_context * pa_stream_get_context(pa_stream *p)
Return the context this stream is attached to.
struct pa_operation pa_operation
An asynchronous operation object.
Definition: operation.h:33
uint32_t pa_stream_get_device_index(pa_stream *s)
Return the index of the sink or source this stream is connected to in the server. ...
int pa_stream_is_suspended(pa_stream *s)
Return 1 if the sink or source this stream is connected to has been suspended.
uint64_t pa_usec_t
Type for usec specifications (unsigned).
Definition: sample.h:260
int pa_stream_get_time(pa_stream *s, pa_usec_t *r_usec)
Return the current playback/recording time.
const pa_format_info * pa_stream_get_format_info(pa_stream *s)
Return a pointer to the stream's format.
void pa_stream_set_read_callback(pa_stream *p, pa_stream_request_cb_t cb, void *userdata)
Set the callback function that is called when new data is available from the stream.
Utility functions for handling a stream or sink format.
A structure for all kinds of timing information of a stream.
Definition: def.h:658
const pa_timing_info * pa_stream_get_timing_info(pa_stream *s)
Return the latest raw timing data structure.
pa_operation * pa_stream_update_timing_info(pa_stream *p, pa_stream_success_cb_t cb, void *userdata)
Request a timing info structure update for a stream.
Constants and routines for channel mapping handling.
uint32_t pa_stream_get_index(pa_stream *s)
Return the sink input resp. source output index this stream is identified in the server with...
int pa_stream_cancel_write(pa_stream *p)
Reverses the effect of pa_stream_begin_write() dropping all data that has already been placed in the ...
void pa_stream_set_buffer_attr_callback(pa_stream *p, pa_stream_notify_cb_t cb, void *userdata)
Set the callback function that is called whenever the buffer attributes on the server side change...
const pa_channel_map * pa_stream_get_channel_map(pa_stream *s)
Return a pointer to the stream's channel map.
pa_stream * pa_stream_new_with_proplist(pa_context *c, const char *name, const pa_sample_spec *ss, const pa_channel_map *map, pa_proplist *p)
Create a new, unconnected stream with the specified name and sample type, and specify the initial str...
Playback and record buffer metrics.
Definition: def.h:387
enum pa_seek_mode pa_seek_mode_t
Seek type for pa_stream_write().
size_t pa_stream_writable_size(pa_stream *p)
Return the number of bytes that may be written using pa_stream_write().
void pa_stream_set_event_callback(pa_stream *p, pa_stream_event_cb_t cb, void *userdata)
Set the callback function that is called whenever a meta/policy control event is received.
void pa_stream_set_started_callback(pa_stream *p, pa_stream_notify_cb_t cb, void *userdata)
Set the callback function that is called when a the server starts playback after an underrun or on in...
void pa_stream_set_state_callback(pa_stream *s, pa_stream_notify_cb_t cb, void *userdata)
Set the callback function that is called whenever the state of the stream changes.
enum pa_update_mode pa_update_mode_t
Update mode enum for pa_proplist_update().
void pa_stream_set_write_callback(pa_stream *p, pa_stream_request_cb_t cb, void *userdata)
Set the callback function that is called when new data may be written to the stream.
int pa_stream_connect_playback(pa_stream *s, const char *dev, const pa_buffer_attr *attr, pa_stream_flags_t flags, const pa_cvolume *volume, pa_stream *sync_stream)
Connect the stream to a sink.
pa_operation * pa_stream_flush(pa_stream *s, pa_stream_success_cb_t cb, void *userdata)
Flush the playback or record buffer of this stream.
void pa_stream_unref(pa_stream *s)
Decrease the reference counter by one.
void(* pa_stream_event_cb_t)(pa_stream *p, const char *name, pa_proplist *pl, void *userdata)
A callback for asynchronous meta/policy event messages.
Definition: stream.h:352
pa_operation * pa_stream_drain(pa_stream *s, pa_stream_success_cb_t cb, void *userdata)
Drain a playback stream.
void pa_stream_set_moved_callback(pa_stream *p, pa_stream_notify_cb_t cb, void *userdata)
Set the callback function that is called whenever the stream is moved to a different sink/source...
struct pa_stream pa_stream
An opaque stream for playback or recording.
Definition: stream.h:335
pa_stream * pa_stream_new_extended(pa_context *c, const char *name, pa_format_info *const *formats, unsigned int n_formats, pa_proplist *p)
Create a new, unconnected stream with the specified name, the set of formats this client can provide...
pa_operation * pa_stream_trigger(pa_stream *s, pa_stream_success_cb_t cb, void *userdata)
Request immediate start of playback on this stream.
Constants and routines for sample type handling.
Asynchronous operations.
pa_operation * pa_stream_proplist_remove(pa_stream *s, const char *const keys[], pa_stream_success_cb_t cb, void *userdata)
Update the property list of the sink input/source output of this stream, remove entries.
int pa_stream_begin_write(pa_stream *p, void **data, size_t *nbytes)
Prepare writing data to the server (for playback streams).
void pa_stream_set_latency_update_callback(pa_stream *p, pa_stream_notify_cb_t cb, void *userdata)
Set the callback function that is called whenever a latency information update happens.
pa_operation * pa_stream_proplist_update(pa_stream *s, pa_update_mode_t mode, pa_proplist *p, pa_stream_success_cb_t cb, void *userdata)
Update the property list of the sink input/source output of this stream, adding new entries...
void(* pa_stream_success_cb_t)(pa_stream *s, int success, void *userdata)
A generic callback for operation completion.
Definition: stream.h:338
pa_stream * pa_stream_new(pa_context *c, const char *name, const pa_sample_spec *ss, const pa_channel_map *map)
Create a new, unconnected stream with the specified name and sample type.
int pa_stream_drop(pa_stream *p)
Remove the current fragment on record streams.
void(* pa_stream_notify_cb_t)(pa_stream *p, void *userdata)
A generic notification callback.
Definition: stream.h:344
enum pa_stream_flags pa_stream_flags_t
Some special flags for stream connections.
Represents the format of data provided in a stream or processed by a sink.
Definition: format.h:85
A channel map which can be used to attach labels to specific channels of a stream.
Definition: channelmap.h:262
pa_operation * pa_stream_cork(pa_stream *s, int b, pa_stream_success_cb_t cb, void *userdata)
Pause (or resume) playback of this stream temporarily.
struct pa_proplist pa_proplist
A property list object.
Definition: proplist.h:272
uint32_t pa_stream_get_monitor_stream(pa_stream *s)
Return the sink input index previously set with pa_stream_set_monitor_stream().
int pa_stream_disconnect(pa_stream *s)
Disconnect a stream from a source/sink.
const pa_buffer_attr * pa_stream_get_buffer_attr(pa_stream *s)
Return the per-stream server-side buffer metrics of the stream.
pa_operation * pa_stream_set_name(pa_stream *s, const char *name, pa_stream_success_cb_t cb, void *userdata)
Rename the stream.
Property list constants and functions.
int pa_stream_connect_record(pa_stream *s, const char *dev, const pa_buffer_attr *attr, pa_stream_flags_t flags)
Connect the stream to a source.
size_t pa_stream_readable_size(pa_stream *p)
Return the number of bytes that may be read using pa_stream_peek().
pa_operation * pa_stream_prebuf(pa_stream *s, pa_stream_success_cb_t cb, void *userdata)
Reenable prebuffering if specified in the pa_buffer_attr structure.