comment which values in pa_{sink,source,sink_input,source_output} structures may be NULL

git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@1204 fefdeb5f-60dc-0310-8127-8f9354f1896f

4 files changed, 37 insertions, 34 deletions

diff --git a/src/pulsecore/sink-input.h b/src/pulsecore/sink-input.h
index b1971d0a..d33f382b 100644
--- a/src/pulsecore/sink-input.h
+++ b/src/pulsecore/sink-input.h
@@ -45,11 +45,11 @@ struct pa_sink_input {
     uint32_t index;
     pa_sink_input_state_t state;
     
-    char *name, *driver;
-    pa_module *owner;
+    char *name, *driver;                /* may be NULL */
+    pa_module *owner;                   /* may be NULL */  
 
     pa_sink *sink;
-    pa_client *client;
+    pa_client *client;                  /* may be NULL */
     
     pa_sample_spec sample_spec;
     pa_channel_map channel_map;
@@ -63,19 +63,19 @@ struct pa_sink_input {
     
     int (*peek) (pa_sink_input *i, pa_memchunk *chunk);
     void (*drop) (pa_sink_input *i, const pa_memchunk *chunk, size_t length);
-    void (*kill) (pa_sink_input *i);
-    pa_usec_t (*get_latency) (pa_sink_input *i);
-    void (*underrun) (pa_sink_input *i);
+    void (*kill) (pa_sink_input *i);             /* may be NULL */
+    pa_usec_t (*get_latency) (pa_sink_input *i); /* may be NULL */
+    void (*underrun) (pa_sink_input *i);         /* may be NULL */
 
     void *userdata;
 
     pa_memchunk resampled_chunk;
-    pa_resampler *resampler;
+    pa_resampler *resampler;                     /* may be NULL */
 
     int variable_rate;
     pa_resample_method_t resample_method;
 
-    pa_memblock *silence_memblock;
+    pa_memblock *silence_memblock;               /* may be NULL */
 };
 
 pa_sink_input* pa_sink_input_new(
diff --git a/src/pulsecore/sink.h b/src/pulsecore/sink.h
index 5a80a013..fb0912ca 100644
--- a/src/pulsecore/sink.h
+++ b/src/pulsecore/sink.h
@@ -48,26 +48,27 @@ struct pa_sink {
     pa_core *core;
     pa_sink_state_t state;
 
-    char *name, *description, *driver;
-    pa_module *owner;
+    char *name;
+    char *description, *driver;            /* may be NULL */
+    int is_hardware;
+
+    pa_module *owner;                      /* may be NULL */
 
     pa_sample_spec sample_spec;
     pa_channel_map channel_map;
 
     pa_idxset *inputs;
-    pa_source *monitor_source;
+    pa_source *monitor_source;             /* may be NULL */
     
     pa_cvolume hw_volume, sw_volume;
     int hw_muted, sw_muted;
 
-    int is_hardware;
-
-    void (*notify)(pa_sink*sink);
-    pa_usec_t (*get_latency)(pa_sink *s);
-    int (*set_hw_volume)(pa_sink *s);
-    int (*get_hw_volume)(pa_sink *s);
-    int (*set_hw_mute)(pa_sink *s);
-    int (*get_hw_mute)(pa_sink *s);
+    void (*notify)(pa_sink*sink);          /* may be NULL */
+    pa_usec_t (*get_latency)(pa_sink *s);  /* dito */
+    int (*set_hw_volume)(pa_sink *s);      /* dito */
+    int (*get_hw_volume)(pa_sink *s);      /* dito */
+    int (*set_hw_mute)(pa_sink *s);        /* dito */
+    int (*get_hw_mute)(pa_sink *s);        /* dito */
     
     void *userdata;
 };
diff --git a/src/pulsecore/source-output.h b/src/pulsecore/source-output.h
index 9a8ea92b..acf53bd1 100644
--- a/src/pulsecore/source-output.h
+++ b/src/pulsecore/source-output.h
@@ -44,20 +44,20 @@ struct pa_source_output {
     uint32_t index;
     pa_source_output_state_t state;
     
-    char *name, *driver;
-    pa_module *owner;
+    char *name, *driver;                  /* may be NULL */
+    pa_module *owner;                     /* may be NULL */
 
     pa_source *source;
-    pa_client *client;
+    pa_client *client;                    /* may be NULL */
 
     pa_sample_spec sample_spec;
     pa_channel_map channel_map;
     
     void (*push)(pa_source_output *o, const pa_memchunk *chunk);
-    void (*kill)(pa_source_output* o);
-    pa_usec_t (*get_latency) (pa_source_output *o);
+    void (*kill)(pa_source_output* o);              /* may be NULL */
+    pa_usec_t (*get_latency) (pa_source_output *o); /* may be NULL */
 
-    pa_resampler* resampler;
+    pa_resampler* resampler;              /* may be NULL */
     pa_resample_method_t resample_method;
     
     void *userdata;
diff --git a/src/pulsecore/source.h b/src/pulsecore/source.h
index 0643a108..be0c969d 100644
--- a/src/pulsecore/source.h
+++ b/src/pulsecore/source.h
@@ -50,26 +50,28 @@ struct pa_source {
     pa_core *core;
     pa_source_state_t state;
     
-    char *name, *description, *driver;
-    pa_module *owner;
+    char *name;
+    char *description, *driver;              /* may be NULL */
+    
+    pa_module *owner;                        /* may be NULL */
 
     pa_sample_spec sample_spec;
     pa_channel_map channel_map;
 
     pa_idxset *outputs;
-    pa_sink *monitor_of;
+    pa_sink *monitor_of;                     /* may be NULL */
 
     pa_cvolume hw_volume, sw_volume;
     int hw_muted, sw_muted;
 
     int is_hardware;
     
-    void (*notify)(pa_source*source);
-    pa_usec_t (*get_latency)(pa_source *s);
-    int (*set_hw_volume)(pa_source *s);
-    int (*get_hw_volume)(pa_source *s);
-    int (*set_hw_mute)(pa_source *s);
-    int (*get_hw_mute)(pa_source *s);
+    void (*notify)(pa_source*source);        /* may be NULL */
+    pa_usec_t (*get_latency)(pa_source *s);  /* dito */
+    int (*set_hw_volume)(pa_source *s);      /* dito */
+    int (*get_hw_volume)(pa_source *s);      /* dito */ 
+    int (*set_hw_mute)(pa_source *s);        /* dito */
+    int (*get_hw_mute)(pa_source *s);        /* dito */
     
     void *userdata;
 };