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     also gst_element_class_get_metadata()
  46
  47     gst_element_factory_get_longname -> gst_element_factory_get_metadata
  48     gst_element_factory_get_klass -> gst_element_factory_get_metadata
  49     gst_element_factory_get_description -> gst_element_factory_get_metadata
  50     gst_element_factory_get_author -> gst_element_factory_get_metadata
  51     gst_element_factory_get_documentation_uri -> gst_element_factory_get_metadata
  52     gst_element_factory_get_icon_name -> gst_element_factory_get_metadata
  53
  54     gstelementmetadata.h contains the keys for all standard metadata.
  55
  56     gst_element_factory_can_{src,sink}_caps() => gst_element_factory_can_{src,sink}_{any,all}_caps()
  57
  58     Element metadata and pad templates are inherited from parent classes and
  59     should be added in class_init instead of base_init.
  60
  61     gst_element_class_add_pad_template() takes ownership of the template
  62
  63     Elements that change the duration must post DURATION messages on the
  64     bus when the duration changes in PAUSED or PLAYING.
  65
  66     gst_element_lost_state_full() -> gst_element_lost_state()
  67     gst_element_lost_state() -> gst_element_lost_state(, TRUE)
  68
  69     request_new_pad_full() -> request_new_pad()
  70
  71     gst_element_found_tags() and gst_element_found_tags_for_pad() are gone, just
  72     push the tag event.
  73
  74 * GstPad:
  75     gst_pad_get_caps() was replaced by gst_pad_query_caps(), it
  76     does not return writable caps anymore and an explicit
  77     gst_caps_make_writable() needs to be performed. This was the functionality
  78     of gst_pad_get_caps_reffed(), which is removed now.
  79
  80     A similar change was done for gst_pad_peer_get_caps() and
  81     gst_pad_peer_get_caps_reffed()
  82
  83     gst_pad_set_bufferalloc_function(), gst_pad_alloc_buffer() and
  84     gst_pad_alloc_buffer_and_set_caps() are removed. Use the ALLOCATION query
  85     now when negotiating formats to obtain a reference to a bufferpool object
  86     that can be used to allocate buffers using gst_buffer_pool_acquire_buffer().
  87
  88     removed sched_private, it should not be used, use g_object_set_qdata() or
  89     use element_private.
  90
  91     Removed GST_PAD_CAPS() use gst_pad_get_current_caps() to get a handle to the
  92     currently configured caps.
  93
  94     GstPadGetCapsFunction, gst_pad_get_caps(), gst_pad_peer_get_caps(),
  95     gst_pad_proxy_getcaps() now takes a GstCaps* parameter to inform
  96     the other side about the possible caps and preferences.
  97
  98     gst_pad_get_pad_template_caps() and gst_pad_get_pad_template()
  99     return a new reference of the caps or template now and the return
 100     value needs to be unreffed after usage.
 101
 102     gst_pad_set_caps() now pushes a CAPS event for backward compatibility.
 103     Consider sending the CAPS event yourself. It is not possible anymore to set
 104     NULL caps.
 105
 106     gst_pad_set_checkgetrange_function() and gst_pad_check_pull_range() are
 107     gone, use the SCHEDULING query now.
 108
 109     gst_pad_set_blocked(), gst_pad_set_blocked_async(),
 110     gst_pad_set_blocked_async_full() are removed, use the gst_pad_add_probe()
 111     method with the GST_PAD_PROBE_TYPE_BLOCK to get the same result as the async
 112     blocking version. There is no more sync version of blocking, this is in
 113     general dangerous and can be implemented using the callbacks if needed.
 114
 115     gst_pad_add_data_probe(), gst_pad_add_data_probe_full(),
 116     gst_pad_remove_data_probe(), gst_pad_add_event_probe(),
 117     gst_pad_add_event_probe_full(), gst_pad_remove_event_probe(),
 118     gst_pad_add_buffer_probe(), gst_pad_add_buffer_probe_full(),
 119     gst_pad_remove_buffer_probe() are removed. Use gst_pad_add_probe() and
 120     gst_pad_remove_probe() for equivalent functionality.
 121
 122     The have-data signal was removed from pads, it was never supposed to be used
 123     without calling the _add_.*_probe() methods.
 124
 125     The request-link signal was removed. It was never used.
 126
 127     gst_pad_get_negotiated_caps() -> get_pad_get_current_caps()
 128
 129     GST_FLOW_UNEXPECTED -> GST_FLOW_EOS
 130
 131     GstActivateMode -> GstPadMode, GST_ACTIVATE_* -> GST_PAD_MODE_*
 132
 133     The GstPadAcceptCapsFunction was removed and replaced with a
 134     GST_QUERY_ACCEPT_CAPS query.
 135
 136     The GstPadFixateCapsFunction was removed. It has no replacement, you can
 137     simply do the fixation in the element or use a vmethod from the base class
 138     if appropriate.
 139
 140     The GstPadGetCapsFunction was removed and replaced with a GST_QUERY_CAPS
 141     query.
 142
 143     gst_pad_proxy_getcaps() -> gst_pad_proxy_query_caps()
 144     gst_pad_get_caps() -> gst_pad_query_caps()
 145     gst_pad_peer_get_caps() -> gst_pad_peer_query_caps()
 146     gst_pad_accept_caps() -> gst_pad_query_accept_caps()
 147     gst_pad_peer_accept_caps() -> gst_pad_peer_query_accept_caps()
 148     gst_pad_query_peer_*() -> gst_pad_peer_query_*()
 149
 150     GstPadFlags: GST_PAD_* -> GST_PAD_FLAG_*
 151
 152 * GstPadTemplate
 153     gst_pad_template_get_caps() returns a new reference of the caps
 154     and the return value needs to be unreffed after usage.
 155
 156     gst_pad_template_new() does not take ownership of the caps anymore.
 157
 158     GstPadTemplate is now created with a floating ref and
 159     gst_element_class_add_pad_template() takes ownership of this floating ref.
 160
 161     GstPadTemplate instances are considered immutable and must not be
 162     changed.
 163
 164 * GstMiniObject
 165     A miniobject is now a simple refcounted structure holding the information
 166     common to buffers, events, messages, queries and caps.
 167
 168     There is no more GST_TYPE_MINIOBJECT as the type for subclasses.
 169     G_TYPE_BOXED can be used as the type of all GstMiniObject based types such
 170     as buffers, events, messages, caps, etc. Signals, for example, would use the
 171     boxed type if the argument include GstMiniObject derived types.
 172
 173     gst_mini_object_new() is removed. You would allocate memory with the the
 174     methods specific for the derived type.
 175
 176     GstParamSpecMiniObject is removed, use boxed param spec now with the GType
 177     of the specific GstMiniObject derived type. Also
 178     gst_param_spec_mini_object().
 179
 180     gst_param_spec_mini_object() -> g_param_spec_boxed()
 181
 182     The specific gst_value_*_mini_object() methods are removed, used the generic
 183     boxed methods instead.
 184
 185     gst_value_set_mini_object() -> g_value_set_boxed()
 186     gst_value_take_mini_object() -> g_value_take_boxed()
 187     gst_value_take_get_object() -> g_value_get_boxed()
 188     gst_value_take_dup_object() -> g_value_dup_boxed()
 189
 190     GST_VALUE_HOLDS_MINI_OBJECT() was removed, use G_VALUE_HOLDS_BOXED() or
 191     type-specific GST_VALUE_HOLDS_{BUFFER,CAPS,etc.}() instead.
 192
 193     The GST_MINI_OBJECT_READONLY flag was removed as it used to mark the
 194     memory in buffers as READONLY. Marking memory READONLY can now be done
 195     with the GstMemory API. Writability of miniobjects is now only done by using
 196     the refcount.
 197
 198 * GstBuffer
 199     A GstBuffer is now a simple boxed type this means that subclassing is not
 200     possible anymore.
 201
 202     To add data to the buffer you would now use gst_buffer_take_memory() with
 203     a GstMemory object containing the data. Multiple memory blocks can added to
 204     a GstBuffer that can then be retrieved with gst_buffer_peek_memory().
 205
 206     GST_BUFFER_DATA(), GST_BUFFER_MALLOCDATA(), GST_BUFFER_FREE_FUNC() and
 207     GST_BUFFER_SIZE() are gone, along with the fields in GstBuffer. Use the
 208     memory API to get access to the buffer data. GST_BUFFER_SIZE() can be
 209     replaced with gst_buffer_get_size() but if also access to the data is
 210     required, gst_buffer_map() can return both the size and data in one go.
 211
 212     The most common way to access all the data in a buffer is by using
 213     gst_buffer_map() and gst_buffer_unmap(). These calls require you to specify
 214     the access mode required to the data and will automatically merge and return
 215     a writable copy of the data.
 216
 217     The buffer must be writable (gst_buffer_is_writable()) in order to modify
 218     the fields, metadata or buffer memory. gst_buffer_make_writable() will not
 219     automatically make a writable copy of the memory but will instead increase
 220     the refcount of the memory. The _map() and _peek_memory() methods will
 221     automatically create writable copies when needed.
 222
 223     gst_buffer_make_metadata_writable() is gone, you can replace this safely
 224     with gst_buffer_make_writable().
 225
 226     gst_buffer_copy_metadata() is gone, use gst_buffer_copy_into() instead and
 227     mind use GST_BUFFER_COPY_METADATA instead of the former GST_BUFFER_COPY_ALL.
 228
 229     gst_buffer_create_sub() is gone and can be safely replaced with
 230     gst_buffer_copy_region().
 231
 232     Changing the size of the buffer data can be done with gst_buffer_resize(),
 233     which will also update the metadata fields correctly. gst_buffer_set_size()
 234     is #defined to a special case of gst_buffer_resize() with a 0 offset.
 235
 236     gst_buffer_try_new_and_alloc() is replaced with gst_buffer_new_and_alloc(),
 237     which now returns NULL when memory allocation fails.
 238
 239     GST_BUFFER_CAPS() is gone, caps are not set on buffers anymore but are set
 240     on the pads where the buffer is pushed on. Likewise GST_BUFFER_COPY_CAPS is
 241     not needed anymore. gst_buffer_get/set_caps() are gone too.
 242
 243     GST_BUFFER_TIMESTAMP is gone, use GST_BUFFER_PTS or GST_BUFFER_DTS instead.
 244     Likewise GST_BUFFER_TIMESTAMP_IS_VALID() was changed to
 245     GST_BUFFER_PTS_IS_VALID and GST_BUFFER_DTS_IS_VALID
 246
 247 * GstBufferList
 248     The GstBufferList object is much simplified because most of the
 249     functionality in the groups is now part of the GstMemory in buffers.
 250
 251     The object is reduced to encapsulating an array of buffers that you can send
 252     with the regular gst_pad_push_list. The iterator is not needed anymore
 253     because you can simply use gst_buffer_list_length() and gst_buffer_list_get()
 254     to iterate the array.
 255
 256     For dealing with the groups, it's now needed to add the memory blocks to
 257     GstBuffer and use the normal buffer API to get and merge the groups.
 258
 259     gst_buffer_list_sized_new() -> gst_buffer_list_new_sized()
 260     gst_buffer_list_len() -> gst_buffer_list_length()
 261
 262 * GstStructure
 263
 264     The GArray of the structure fields are moved to private part and are not
 265     accessible from the application anymore. Use the methods to retrieve and
 266     modify fields from the array.
 267
 268     gst_structure_empty_new() -> gst_structure_new_empty()
 269     gst_structure_id_empty_new() -> gst_structure_new_id_empty()
 270     gst_structure_id_new() -> gst_structure_new_id()
 271
 272 * GstEvent
 273     Boxed types derived from GstMiniObject.
 274
 275     GST_EVENT_SRC is removed. Don't use this anymore.
 276
 277     gst_event_new_qos_full() -> gst_event_new_qos()
 278     gst_event_parse_qos_full() -> gst_event_parse_qos()
 279
 280     The GstStructure is removed from the public API, use the getters to get
 281     a handle to a GstStructure.
 282
 283     GST_EVENT_NEWSEGMENT -> GST_EVENT_SEGMENT
 284
 285     gst_event_new_new_segment () -> gst_event_new_segment() and it takes a
 286     GstSegment structure as an argument.
 287     gst_event_parse_new_segment() -> gst_event_parse_segment() to retrieve the
 288     GstSegment structure from the event.
 289     gst_event_copy_segment() to fill a GstSegment structure.
 290
 291 * GstQuery
 292     Boxed types derived from GstMiniObject.
 293
 294     The GstStructure is removed from the public API, use the getters to get
 295     a handle to a GstStructure.
 296
 297     gst_query_new_application() -> gst_query_new_custom()
 298
 299     gst_query_parse_formats_length() -> gst_query_parse_n_formats()
 300     gst_query_parse_formats_nth() -> gst_query_parse_nth_format()
 301
 302     Some query utility functions no longer use an inout parameter for the
 303     destination/query format:
 304
 305       - gst_pad_query_position()
 306       - gst_pad_query_duration()
 307       - gst_pad_query_convert()
 308       - gst_pad_query_peer_position()
 309       - gst_pad_query_peer_duration()
 310       - gst_pad_query_peer_convert()
 311       - gst_element_query_position()
 312       - gst_element_query_duration()
 313       - gst_element_query_convert()
 314
 315     gst_element_get_query_types() and gst_pad_get_query_types() with associated
 316     functions were removed.
 317
 318 * GstBufferList
 319     Is now a boxed type derived from GstMiniObject.
 320
 321 * GstMessage
 322     Is now a boxed type derived from GstMiniObject
 323
 324     The GstStructure is removed from the public API, use the getters to get
 325     a handle to a GstStructure.
 326
 327 * GstCaps
 328     Is now a boxed type derived from GstMiniObject.
 329
 330     GST_VIDEO_CAPS_xxx -> GST_VIDEO_CAPS_MAKE(xxx)
 331
 332 * GstSegment
 333     abs_rate was removed from the public fields, it can be trivially calculated
 334     from the rate field.
 335
 336     accum was renamed to base. last_stop was renamed to position.
 337
 338     The segment info now contains all the information needed to convert buffer
 339     timestamps to running_time and stream_time. There is no more segment
 340     accumulation, the GstSegment is completely self contained.
 341
 342     gst_segment_set_duration() and gst_segment_set_last_stop() are removed,
 343     simply modify the structure members duration and position respectively.
 344
 345     gst_segment_set_newsegment() is removed, it was used to accumulate segments
 346     and is not needed anymore, use gst_segment_copy_into() or modify the segment
 347     values directly.
 348
 349     gst_segment_set_seek() -> gst_segment_do_seek(). Updates the segment values
 350     with seek parameters.
 351
 352 * GstPluginFeature
 353     GST_PLUGIN_FEATURE_NAME() was removed, use GST_OBJECT_NAME() instead.
 354
 355 * GstTypeFind
 356     gst_type_find_peek() returns a const guint8 * now.
 357
 358 * GstTask
 359     gst_task_create() -> gst_task_new()
 360
 361 * GstAdapter
 362     gst_adapter_peek() is removed, use gst_adapter_map() and gst_adapter_unmap()
 363     to get access to raw data from the adapter.
 364
 365     Arguments changed from guint to gsize.
 366
 367     gst_adapter_prev_timestamp() is removed and should be replaced with
 368     gst_adapter_prev_pts() and gst_adapter_prev_dts().
 369
 370 * GstBitReader, GstByteReader, GstByteWriter
 371     gst_*_reader_new_from_buffer(), gst_*_reader_init_from_buffer() removed, get
 372     access to the buffer data with _map() and then use the _new() functions.
 373
 374     gst_byte_reader_new_from_buffer() and gst_byte_reader_init_from_buffer()
 375     removed, get access to the buffer data and then use the _new() functions.
 376
 377 * GstCollectPads
 378     gst_collect_pads_read() removed, use _read_buffer() or _take_buffer() and
 379     then use the memory API to get to the memory.
 380
 381 * GstBaseSrc, GstBaseTransform, GstBaseSink
 382     GstBaseSrc::get_caps(), GstBaseTransform::transform_caps() and
 383     GstBaseSink::get_caps() now take a filter GstCaps* parameter to
 384     filter the caps and allow better negotiation decisions.
 385
 386 * GstBaseTransform
 387     GstBaseTransform::transform_caps() now gets the complete caps passed
 388     instead of getting it passed structure by structure.
 389
 390     GstBaseTransform::event() was renamed to sink_event(). The old function
 391     uses the return value to determine if the event should be forwarded or not.
 392     The new function has a default implementation that always forwards the event
 393     and the return value is simply returned as a result from the event handler.
 394     The semantics of the sink_event are thus the same as those for the src_event
 395     function.
 396
 397 * GstImplementsInterface
 398     has been removed. Interfaces need to be updated to either have
 399     is_ready/usable/available() methods, or have GError arguments
 400     to their methods so we can return an appropriate error if a
 401     particular interface isn't supported for a particular device.
 402
 403 * GstIterator
 404     uses a GValue based API now that is similar to the 0.10 API but
 405     allows bindings to properly use GstIterator and prevents complex
 406     return value ownership issues.
 407
 408 * GstURIHandler
 409     gst_uri_handler_get_uri() and the get_uri vfunc now return a copy of
 410     the URI string
 411
 412     gst_uri_handler_set_uri() and the set_uri vfunc now take an additional
 413     GError argument so the handler can notify the caller why it didn't
 414     accept a particular URI.
 415
 416     gst_uri_handler_set_uri() now checks if the protocol of the URI passed
 417     is one of the protocols advertised by the uri handler, so set_uri vfunc
 418     implementations no longer need to check that as well.
 419
 420 * GstTagList
 421     is now an opaque object instead of being typedefed to a GstStructure. Cast
 422     to GstStructure or use gst_structure_* API on it at your own peril (it may
 423     still work for now, but might be changed in future).
 424
 425     gst_tag_list_new() has been renamed to gst_tag_list_new_empty().
 426     gst_tag_list_new_full*() have been renamed to gst_tag_list_new*().
 427
 428 * GstController:
 429     has now been merged into GstObject. It does not exists as a individual
 430     object anymore. In addition core contains a GstControlSource base class and
 431     the GstControlBinding. The actual control sources are in the controller
 432     library as before. The 2nd big change is that control sources generate
 433     a sequence of gdouble values and those are mapped to the property type and
 434     value range by GstControlBindings.
 435
 436     For plugins the effect is that gst_controller_init() is gone and
 437     gst_object_sync_values() is taking a GstObject * instead of GObject *.
 438
 439     For applications the effect is larger. The whole gst_controller_* API is
 440     gone and now available in simplified form under gst_object_*. ControlSources
 441     are now attached via GstControlBinding to properties. There are no GValue
 442     arguments used anymore when programming control sources.
 443
 444     gst_controller_new* -> gst_object_set_control_source
 445     gst_controller_add_properties -> gst_object_set_control_source
 446     gst_controller_set_control_source -> gst_object_set_control_source
 447     gst_controller_get_control_source -> gst_object_get_control_source
 448
 449     gst_controller_set_property_disabled -> gst_object_set_controlled_property_disabled
 450
 451     gst_object_get_value_arrays has been removed. Loop over the controlled
 452     properties fetch the value array. Also GstValueArray is gone. The fields of
 453     GstValueArray are now passed directly to gst_object_get_value_array as
 454     arguments.
 455
 456     GstInterpolationControlSource has been split. There is a new
 457     GstTimedValueControlSource baseclass and 2 sub classes:
 458     GstInterpolationControlSource and GstTriggerControlSource. The API for setting
 459     and getting the timestamps is in GstTimedValueControlSource.
 460
 461     gst_interpolation_control_source_set_interpolation_mode() has been removed.
 462     Set the "mode" gobject property on the control-source instead. The possible
 463     enum values have been renamed from GST_INTERPOLATE_XXX to
 464     GST_INTERPOLATION_MODE_XXX.
 465
 466 * GstRegistry
 467
 468     gst_registry_get_default() -> gst_registry_get()
 469     gst_default_registry_*(...) -> gst_registry_*(gst_registry_get(), ...)
 470
 471 * GstValue
 472
 473     GST_TYPE_DATE -> G_TYPE_DATE
 474     GST_VALUE_HOLDS_DATE(value) -> G_VALUE_HOLDS(value,G_TYPE_DATE)
 475     gst_value_set_date() -> g_value_set_boxed()
 476     gst_value_get_date() -> g_value_get_boxed()
 477
 478 * GError/GstGError
 479
 480     GstGError -> GError
 481     GST_TYPE_G_ERROR / gst_g_error_get_type() -> G_TYPE_ERROR
 482
 483 * "codec-data" and "streamheader" field in GstCaps
 484
 485     codec-data and stream headers are no longer in GstCaps, but sent as
 486     part of a STREAM CONFIG event (which should be sent after the initial
 487     CAPS event if needed).