docs/random/porting-to-0.11.txt

   1 The 0.11 porting guide
   2 ----------------------
   3
   4 * All deprecated methods were removed. Recompile against 0.10 with
   5   DISABLE_DEPRECATED and fix issues before attempting to port to 0.11.
   6
   7 * GST_BOILERPLATE is gone, use G_DEFINE_TYPE instead.
   8
   9 * various methods take a gsize instead of a guint when talking about memory
  10   sizes.
  11
  12 * multifdsink, tcpclientsink, tcpclientsrc, tcpserversrc the protocol property
  13   is removed, use gdppay and gdpdepay.
  14
  15 * Presets and plugins moved to $XDG_DATA_HOME/gstreamer-0.11/ root
  16   directory. Registry moved to $XDG_CACHE_HOME/gstreamer-0.11/.
  17   XDG_CACHE_HOME usually points to $HOME/.cache and XDG_DATA_HOME
  18   usually is $HOME/.local/share/.
  19
  20 * GstObject:
  21     GST_OBJECT_DISPOSING flag removed
  22     GST_OBJECT_IS_DISPOSING removed
  23     GST_OBJECT_FLOATING flag remove, GstObject is now GInitiallyUnowned
  24     GST_OBJECT_IS_FLOATING removed, use g_object_is_floating()
  25
  26     GST_CLASS_GET_LOCK, GST_CLASS_LOCK, GST_CLASS_TRYLOCK, GST_CLASS_UNLOCK,
  27     used to be a workaround for thread-unsafe glib < 2.8
  28
  29     gst_object_ref_sink() has gpointer as result to make it more like the
  30     GObject version.
  31
  32     gst_object_sink() removed, use gst_object_ref_sink() instead.
  33
  34     gst_class_signal_connect() removed, was only used for XML
  35
  36     parent-set and parent-unset signals removed. Use notify:parent. Currently
  37     still disabled because of deep notify locking issues.
  38
  39 * GstElement:
  40     GstElementDetails is removed and replaced with more generic metadata.
  41
  42     gst_element_class_set_details_simple() -> gst_element_class_set_metadata()
  43     gst_element_class_set_documentation_uri -> gst_element_class_add_metadata
  44     gst_element_class_set_icon_name -> gst_element_class_add_metadata
  45
  46     gst_element_factory_get_longname -> gst_element_factory_get_metadata
  47     gst_element_factory_get_klass -> gst_element_factory_get_metadata
  48     gst_element_factory_get_description -> gst_element_factory_get_metadata
  49     gst_element_factory_get_author -> gst_element_factory_get_metadata
  50     gst_element_factory_get_documentation_uri -> gst_element_factory_get_metadata
  51     gst_element_factory_get_icon_name -> gst_element_factory_get_metadata
  52
  53     gstelementmetadata.h contains the keys for all standard metadata.
  54
  55     Element metadata and pad templates are inherited from parent classes and
  56     should be added in class_init instead of base_init.
  57
  58     gst_element_class_add_pad_template() takes ownership of the template
  59
  60     Elements that change the duration must post DURATION messages on the
  61     bus when the duration changes in PAUSED or PLAYING.
  62
  63     gst_element_lost_state_full() -> gst_element_lost_state()
  64     gst_element_lost_state() -> gst_element_lost_state(, TRUE)
  65
  66 * GstPad:
  67     gst_pad_get_caps() does not return writable caps anymore and an explicit
  68     gst_caps_make_writable() needs to be performed. This was the functionality
  69     of gst_pad_get_caps_reffed(), which is removed now.
  70
  71     A similar change was done for gst_pad_peer_get_caps() and
  72     gst_pad_peer_get_caps_reffed()
  73
  74     gst_pad_set_bufferalloc_function(), gst_pad_alloc_buffer() and
  75     gst_pad_alloc_buffer_and_set_caps() are removed. Use the ALLOCATION query
  76     now to obtain a reference to a bufferpool object that can be used to
  77     allocate buffers.
  78
  79     removed sched_private, it should not be used, use g_object_set_qdata() or
  80     use element_private.
  81
  82     Removed GST_PAD_CAPS() use gst_pad_get_current_caps() to get a handle to the
  83     currently configured caps.
  84
  85 * GstMiniObject
  86     A miniobject is now a simple refcounted structure holding the information
  87     common to buffers, events, messages, queries and caps.
  88
  89     There is no more GST_TYPE_MINIOBJECT as the type for subclasses.
  90     G_TYPE_BOXED can be used as the type of all GstMiniObject based types such
  91     as buffers, events, messages, caps, etc. Signals, for example, would use the
  92     boxed type if the argument include GstMiniObject derived types.
  93
  94     gst_mini_object_new() is removed. You would allocate memory with the the
  95     methods specific for the derived type.
  96
  97     GstParamSpecMiniObject is removed, use boxed param spec now with the GType
  98     of the specific GstMiniObject derived type. Also
  99     gst_param_spec_mini_object().
 100
 101     gst_param_spec_mini_object() -> g_param_spec_boxed()
 102
 103     The specific gst_value_*_mini_object() methods are removed, used the generic
 104     boxed methods instead.
 105
 106     gst_value_set_mini_object() -> g_value_set_boxed()
 107     gst_value_take_mini_object() -> g_value_take_boxed()
 108     gst_value_take_get_object() -> g_value_get_boxed()
 109     gst_value_take_dup_object() -> g_value_dup_boxed()
 110
 111     The GST_MINI_OBJECT_READONLY flag was removed as it used to mark the
 112     memory in buffers as READONLY. Marking memory READONLY can now be done
 113     with the GstMemory API. Writability of miniobjects is now only done by using
 114     the refcount.
 115
 116 * GstBuffer
 117     A GstBuffer is now a simple boxed type this means that subclassing is not
 118     possible anymore.
 119
 120     To add data to the buffer you would now use gst_buffer_take_memory() with
 121     a GstMemory object containing the data. Multiple memory blocks can added to
 122     a GstBuffer that can then be retrieved with gst_buffer_peek_memory().
 123
 124     GST_BUFFER_DATA(), GST_BUFFER_MALLOCDATA(), GST_BUFFER_FREE_FUNC() and
 125     GST_BUFFER_SIZE() are gone, along with the fields in GstBuffer. Use the
 126     memory API to get access to the buffer data. GST_BUFFER_SIZE() can be
 127     replaced with gst_buffer_get_size() but if also access to the data is
 128     required, gst_buffer_map() can return both the size and data in one go.
 129
 130     The most common way to access all the data in a buffer is by using
 131     gst_buffer_map() and gst_buffer_unmap(). These calls require you to specify
 132     the access mode required to the data and will automatically merge and return
 133     a writable copy of the data.
 134
 135     The buffer must be writable (gst_buffer_is_writable()) in order to modify
 136     the fields, metadata or buffer memory. gst_buffer_make_writable() will not
 137     automatically make a writable copy of the memory but will instead increase
 138     the refcount of the memory. The _map() and _peek_memory() methods will
 139     automatically create writable copies when needed.
 140
 141     gst_buffer_make_metadata_writable() is gone, you can replace this safely
 142     with gst_buffer_make_writable().
 143
 144     gst_buffer_create_sub() is gone and can be safely replaced with
 145     gst_buffer_copy_region().
 146
 147     Changing the size of the buffer data can be done with gst_buffer_resize(),
 148     which will also update the metadata fields correctly. gst_buffer_set_size()
 149     is #defined to a special case of gst_buffer_resize() with a 0 offset.
 150
 151     gst_buffer_try_new_and_alloc() is replaced with gst_buffer_new_and_alloc(),
 152     which now returns NULL when memory allocation fails.
 153
 154     GST_BUFFER_CAPS() is gone, caps are not set on buffers anymore but are set
 155     on the pads where the buffer is pushed on. Likewise GST_BUFFER_COPY_CAPS is
 156     not needed anymore. gst_buffer_get/set_caps() are gone too.
 157
 158 * GstBufferList
 159     The GstBufferList object is much simplified because most of the
 160     functionality in the groups is now part of the GstMemory in buffers.
 161
 162     The object is reduced to encapsulating an array of buffers that you can send
 163     with the regular gst_pad_push_list. The iterator is not needed anymore
 164     because you can simply use gst_buffer_list_len() and gst_buffer_list_get()
 165     to iterate the array.
 166
 167     For dealing with the groups, it's now needed to add the memory blocks to
 168     GstBuffer and use the normal buffer API to get and merge the groups.
 169
 170 * GstEvent
 171     GST_EVENT_SRC is removed. Don't use this anymore.
 172
 173     gst_event_new_new_segment_full() -> gst_event_new_new_segment()
 174     gst_event_parse_new_segment_full() -> gst_event_parse_new_segment()
 175
 176     gst_event_new_qos_full() -> gst_event_new_qos()
 177     gst_event_parse_qos_full() -> gst_event_parse_qos()
 178
 179     The GstStructure is removed from the public API, use the getters to get
 180     a handle to a GstStructure.
 181
 182 * GstQuery
 183     Boxed types derived from GstMiniObject.
 184
 185     The GstStructure is removed from the public API, use the getters to get
 186     a handle to a GstStructure.
 187
 188 * GstBufferList
 189     Is now a boxed type derived from GstMiniObject.
 190
 191 * GstMessage
 192     Is now a boxed type derived from GstMiniObject
 193
 194     The GstStructure is removed from the public API, use the getters to get
 195     a handle to a GstStructure.
 196
 197 * GstCaps
 198     Is now a boxed type derived from GstMiniObject.
 199
 200 * GstSegment
 201     abs_rate was removed from the public fields, it can be trivially calculated
 202     from the rate field.
 203
 204 * GstTypeFind
 205     gst_type_find_peek() returns a const guin8 * now.
 206
 207 * GstAdapter
 208     gst_adapter_peek() is removed, use gst_adapter_map() and gst_adapter_unmap()
 209     to get access to raw data from the adapter.
 210
 211     Arguments renamed from guint to gsize.
 212
 213 * GstBitReader, GstByteReader, GstByteWriter
 214     gst_*_reader_new_from_buffer(), gst_*_reader_init_from_buffer() removed, get
 215     access to the buffer data with _map() and then use the _new() functions.
 216
 217     gst_byte_reader_new_from_buffer() and gst_byte_reader_init_from_buffer()
 218     removed, get access to the buffer data and then use the _new() functions.
 219
 220 * GstCollectPads
 221     gst_collect_pads_read() removed, use _read_buffer() or _take_buffer() and
 222     then use the memory API to get to the memory.
 223
 224
 225
 226