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 * various methods take a gsize instead of a guint when talking about memory
   8   sizes.
   9
  10 * multifdsink, tcpclientsink, tcpclientsrc, tcpserversrc the protocol property
  11   is removed, use gdppay and gdpdepay.
  12
  13 * GstObject:
  14     GST_OBJECT_DISPOSING flag removed
  15     GST_OBJECT_IS_DISPOSING removed
  16     GST_OBJECT_FLOATING flag remove, GstObject is now GInitiallyUnowned
  17     GST_OBJECT_IS_FLOATING removed, use g_object_is_floating()
  18
  19     GST_CLASS_GET_LOCK, GST_CLASS_LOCK, GST_CLASS_TRYLOCK, GST_CLASS_UNLOCK,
  20     used to be a workaround for thread-unsafe glib < 2.8
  21
  22     gst_object_ref_sink() has gpointer as result to make it more like the
  23     GObject version.
  24
  25     gst_object_sink() removed, use gst_object_ref_sink() instead.
  26
  27     gst_class_signal_connect() removed, was only used for XML
  28
  29     parent-set and parent-unset signals removed. Use notify:parent. Currently
  30     still disabled because of deep notify locking issues.
  31
  32 * GstElement:
  33     GstElementDetails is removed and replaced with more generic metadata.
  34
  35     gst_element_class_set_details_simple() -> gst_element_class_set_metadata()
  36     gst_element_class_set_documentation_uri -> gst_element_class_add_metadata
  37     gst_element_class_set_icon_name -> gst_element_class_add_metadata
  38
  39     gst_element_factory_get_longname -> gst_element_factory_get_metadata
  40     gst_element_factory_get_klass -> gst_element_factory_get_metadata
  41     gst_element_factory_get_description -> gst_element_factory_get_metadata
  42     gst_element_factory_get_author -> gst_element_factory_get_metadata
  43     gst_element_factory_get_documentation_uri -> gst_element_factory_get_metadata
  44     gst_element_factory_get_icon_name -> gst_element_factory_get_metadata
  45
  46     gstelementmetadata.h contains the keys for all standard metadata.
  47
  48 * GstPad:
  49     gst_pad_get_caps() does not return writable caps anymore and an explicit
  50     gst_caps_make_writable() needs to be performed. This was the functionality
  51     of gst_pad_get_caps_reffed(), which is removed now.
  52
  53     A similar change was done for gst_pad_peer_get_caps() and
  54     gst_pad_peer_get_caps_reffed()
  55
  56 * GstMiniObject
  57     A miniobject is now a simple refcounted structure holding the information
  58     common to buffers, events, messages, queries and caps.
  59
  60     There is no more GST_TYPE_MINIOBJECT as the type for subclasses.
  61     G_TYPE_BOXED can be used as the type of all GstMiniObject based types such
  62     as buffers, events, messages, caps, etc. Signals, for example, would use the
  63     boxed type if the argument include GstMiniObject derived types.
  64
  65     gst_mini_object_new() is removed. You would allocate memory with the the
  66     methods specific for the derived type.
  67
  68     GstParamSpecMiniObject is removed, use boxed param spec now with the GType
  69     of the specific GstMiniObject derived type. Also
  70     gst_param_spec_mini_object().
  71
  72     gst_param_spec_mini_object() -> g_param_spec_boxed()
  73
  74     The specific gst_value_*_mini_object() methods are removed, used the generic
  75     boxed methods instead.
  76
  77     gst_value_set_mini_object() -> g_value_set_boxed()
  78     gst_value_take_mini_object() -> g_value_take_boxed()
  79     gst_value_take_get_object() -> g_value_get_boxed()
  80     gst_value_take_dup_object() -> g_value_dup_boxed()
  81
  82     The GST_MINI_OBJECT_READONLY flag was removed as it used to mark the
  83     memory in buffers as READONLY. Marking memory READONLY can now be done
  84     with the GstMemory API. Writability of miniobjects is now only done by using
  85     the refcount.
  86
  87 * GstBuffer
  88     A GstBuffer is now a simple boxed type this means that subclassing is not
  89     possible anymore.
  90
  91     To add data to the buffer you would now use gst_buffer_take_memory() with
  92     a GstMemory object containing the data. Multiple memory blocks can added to
  93     a GstBuffer that can then be retrieved with gst_buffer_peek_memory().
  94
  95     GST_BUFFER_DATA(), GST_BUFFER_MALLOCDATA(), GST_BUFFER_FREE_FUNC() and
  96     GST_BUFFER_SIZE() are gone, along with the fields in GstBuffer. Use the
  97     memory API to get access to the buffer data. GST_BUFFER_SIZE() can be
  98     replaced with gst_buffer_get_size() but if also access to the data is
  99     required, gst_buffer_map() can return both the size and data in one go.
 100
 101     The most common way to access all the data in a buffer is by using
 102     gst_buffer_map() and gst_buffer_unmap(). These calls require you to specify
 103     the access mode required to the data and will automatically merge and return
 104     a writable copy of the data.
 105
 106     The buffer must be writable (gst_buffer_is_writable()) in order to modify
 107     the fields, metadata or buffer memory. gst_buffer_make_writable() will not
 108     automatically make a writable copy of the memory but will instead increase
 109     the refcount of the memory. The _map() and _peek_memory() methods will
 110     automatically create writable copies when needed.
 111
 112     gst_buffer_make_metadata_writable() is gone, you can replace this safely
 113     with gst_buffer_make_writable().
 114
 115     gst_buffer_create_sub() is gone and can be safely replaced with
 116     gst_buffer_copy_region().
 117
 118     Changing the size of the buffer data can be done with gst_buffer_resize(),
 119     which will also update the metadata fields correctly. gst_buffer_set_size()
 120     is #defined to a special case of gst_buffer_resize() with a 0 offset.
 121
 122     gst_buffer_try_new_and_alloc() is replaced with gst_buffer_new_and_alloc(),
 123     which now returns NULL when memory allocation fails.
 124
 125 * GstBufferList
 126     The GstBufferList object is much simplified because most of the
 127     functionality in the groups is now part of the GstMemory in buffers.
 128
 129     The object is reduced to encapsulating an array of buffers that you can send
 130     with the regular gst_pad_push_list. The iterator is not needed anymore
 131     because you can simply use gst_buffer_list_len() and gst_buffer_list_get()
 132     to iterate the array.
 133
 134     For dealing with the groups, it's now needed to add the memory blocks to
 135     GstBuffer and use the normal buffer API to get and merge the groups.
 136
 137 * GstEvent
 138 * GstQuery
 139     Boxed types derived from GstMiniObject.
 140
 141 * GstBufferList
 142     Is now a boxed type derived from GstMiniObject.
 143
 144 * GstMessage
 145     Is now a boxed type derived from GstMiniObject
 146
 147 * GstCaps
 148     Is now a boxed type derived from GstMiniObject.
 149
 150 * GstTypeFind
 151     gst_type_find_peek() returns a const guin8 * now.
 152
 153 * GstAdapter
 154     gst_adapter_peek() is removed, use gst_adapter_map() and gst_adapter_unmap()
 155     to get access to raw data from the adapter.
 156
 157     Arguments renamed from guint to gsize.
 158
 159 * GstBitReader, GstByteReader, GstByteWriter
 160     gst_*_reader_new_from_buffer(), gst_*_reader_init_from_buffer() removed, get
 161     access to the buffer data with _map() and then use the _new() functions.
 162
 163     gst_byte_reader_new_from_buffer() and gst_byte_reader_init_from_buffer()
 164     removed, get access to the buffer data and then use the _new() functions.
 165
 166 * GstCollectPads
 167     gst_collect_pads_read() removed, use _read_buffer() or _take_buffer() and
 168     then use the memory API to get to the memory.
 169
 170
 171
 172