pidgin/pidgin

Replace PurpleIdleUiOps with the PurpleIdleUi Interface

2021-10-22, Gary Kramlich
5397330041d6
Replace PurpleIdleUiOps with the PurpleIdleUi Interface

This continues our path down replacing the UiOps with Interfaces so that
developers can write user interfaces in other languages using gobject
introspection.

Testing Done:
Ran pidgin3 and set it to auto idle after 1 minute of system idle time. This attempted to query xscreen saver, but something didn't work there, but that's been happening before this change. Not sure if it's my system or the code just needs fixing.

Ran finch3 set idle time to 1 minute and verified that it set me to away after that minute.

I also used the libpurple idle time for both pidgin3 and finch3 and verified they continued to work as well.

Reviewed at https://reviews.imfreedom.org/r/1091/
/* purple
*
* Purple is the legal property of its developers, whose names are too numerous
* to list here. Please refer to the COPYRIGHT file distributed with this
* source distribution.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*/
#if !defined(PURPLE_GLOBAL_HEADER_INSIDE) && !defined(PURPLE_COMPILATION)
# error "only <purple.h> may be included directly"
#endif
#ifndef PURPLE_MEDIA_GST_H
#define PURPLE_MEDIA_GST_H
/**
* SECTION:media-gst
* @section_id: libpurple-media-gst
* @short_description: <filename>media-gst.h</filename>
* @title: Media Element API
*/
#include "media.h"
#include "mediamanager.h"
#include <gst/gst.h>
/**
* PURPLE_TYPE_MEDIA_ELEMENT_TYPE:
*
* The standard _get_type macro for #PurpleMediaElementType.
*/
#define PURPLE_TYPE_MEDIA_ELEMENT_TYPE purple_media_element_type_get_type()
/**
* PURPLE_TYPE_MEDIA_ELEMENT_INFO:
*
* The standard _get_type macro for #PurpleMediaElementInfo.
*/
#define PURPLE_TYPE_MEDIA_ELEMENT_INFO purple_media_element_info_get_type()
/**
* PurpleMediaElementInfo:
*
* An opaque structure representing an audio/video source/sink.
*/
typedef struct _PurpleMediaElementInfo PurpleMediaElementInfo;
typedef GstElement *(*PurpleMediaElementCreateCallback)(
PurpleMediaElementInfo *info, PurpleMedia *media,
const gchar *session_id, const gchar *participant);
/**
* PurpleMediaElementType:
* @PURPLE_MEDIA_ELEMENT_NONE: empty element
* @PURPLE_MEDIA_ELEMENT_AUDIO: supports audio
* @PURPLE_MEDIA_ELEMENT_VIDEO: supports video
* @PURPLE_MEDIA_ELEMENT_AUDIO_VIDEO: supports audio and video
* @PURPLE_MEDIA_ELEMENT_NO_SRCS: has no src pads
* @PURPLE_MEDIA_ELEMENT_ONE_SRC: has one src pad
* @PURPLE_MEDIA_ELEMENT_MULTI_SRC: has multiple src pads
* @PURPLE_MEDIA_ELEMENT_REQUEST_SRC: src pads must be requested
* @PURPLE_MEDIA_ELEMENT_NO_SINKS: has no sink pads
* @PURPLE_MEDIA_ELEMENT_ONE_SINK: has one sink pad
* @PURPLE_MEDIA_ELEMENT_MULTI_SINK: has multiple sink pads
* @PURPLE_MEDIA_ELEMENT_REQUEST_SINK: sink pads must be requested
* @PURPLE_MEDIA_ELEMENT_UNIQUE: This element is unique and only one
* instance of it should be created at a
* time
* @PURPLE_MEDIA_ELEMENT_SRC: can be set as an active src
* @PURPLE_MEDIA_ELEMENT_SINK: can be set as an active sink
* @PURPLE_MEDIA_ELEMENT_APPLICATION: supports application data
*/
typedef enum {
PURPLE_MEDIA_ELEMENT_NONE = 0,
PURPLE_MEDIA_ELEMENT_AUDIO = 1,
PURPLE_MEDIA_ELEMENT_VIDEO = 1 << 1,
PURPLE_MEDIA_ELEMENT_AUDIO_VIDEO = PURPLE_MEDIA_ELEMENT_AUDIO
| PURPLE_MEDIA_ELEMENT_VIDEO,
PURPLE_MEDIA_ELEMENT_NO_SRCS = 0,
PURPLE_MEDIA_ELEMENT_ONE_SRC = 1 << 2,
PURPLE_MEDIA_ELEMENT_MULTI_SRC = 1 << 3,
PURPLE_MEDIA_ELEMENT_REQUEST_SRC = 1 << 4,
PURPLE_MEDIA_ELEMENT_NO_SINKS = 0,
PURPLE_MEDIA_ELEMENT_ONE_SINK = 1 << 5,
PURPLE_MEDIA_ELEMENT_MULTI_SINK = 1 << 6,
PURPLE_MEDIA_ELEMENT_REQUEST_SINK = 1 << 7,
PURPLE_MEDIA_ELEMENT_UNIQUE = 1 << 8,
PURPLE_MEDIA_ELEMENT_SRC = 1 << 9,
PURPLE_MEDIA_ELEMENT_SINK = 1 << 10,
PURPLE_MEDIA_ELEMENT_APPLICATION = 1 << 11,
} PurpleMediaElementType;
G_BEGIN_DECLS
/**
* purple_media_element_type_get_type:
*
* Gets the element type's GType.
*
* Returns: The element type's GType.
*/
GType purple_media_element_type_get_type(void);
/**
* purple_media_element_info_get_type:
*
* Gets the element info's GType.
*
* Returns: The element info's GType.
*/
G_DECLARE_FINAL_TYPE(PurpleMediaElementInfo, purple_media_element_info, PURPLE,
MEDIA_ELEMENT_INFO, GObject)
/**
* purple_media_get_src:
* @media: The media object the session is in.
* @sess_id: The session id of the session to get the source from.
*
* Gets the source from a session
*
* Returns: (transfer none): The source retrieved.
*/
GstElement *purple_media_get_src(PurpleMedia *media, const gchar *sess_id);
/**
* purple_media_get_tee:
* @media: The instance to get the tee from.
* @session_id: The id of the session to get the tee from.
* @participant: Optionally, the participant of the stream to get the tee from.
*
* Gets the tee from a given session/stream.
*
* Returns: (transfer none): The GstTee element from the chosen session/stream.
*/
GstElement *purple_media_get_tee(PurpleMedia *media,
const gchar *session_id, const gchar *participant);
/**
* purple_media_manager_get_pipeline:
* @manager: The media manager to get the pipeline from.
*
* Gets the pipeline from the media manager.
*
* Returns: (transfer none): The pipeline.
*/
GstElement *purple_media_manager_get_pipeline(PurpleMediaManager *manager);
/**
* purple_media_manager_get_element:
* @manager: The media manager to use to obtain the source/sink.
* @type: The type of source/sink to get.
* @media: The media call this element is requested for.
* @session_id: The id of the session this element is requested for or NULL.
* @participant: The remote user this element is requested for or NULL.
*
* Returns: (transfer full): A GStreamer source or sink for audio or video.
*/
GstElement *purple_media_manager_get_element(PurpleMediaManager *manager,
PurpleMediaSessionType type, PurpleMedia *media,
const gchar *session_id, const gchar *participant);
/**
* purple_media_manager_enumerate_elements:
* @manager: The media manager to use to obtain the element infos.
* @type: The type of element infos to get.
*
* Returns: (transfer container) (element-type PurpleMediaElementInfo): A #GList of registered #PurpleMediaElementInfo instances that match
* @type.
*
* Since: 3.0.0
*/
GList *purple_media_manager_enumerate_elements(PurpleMediaManager *manager,
PurpleMediaElementType type);
/**
* purple_media_manager_get_element_info:
* @manager: The #PurpleMediaManager instance
* @name: The name of the element to get.
*
* Returns: (transfer full): The #PurpleMediaElementInfo for @name or NULL.
*/
PurpleMediaElementInfo *purple_media_manager_get_element_info(
PurpleMediaManager *manager, const gchar *name);
gboolean purple_media_manager_register_element(PurpleMediaManager *manager,
PurpleMediaElementInfo *info);
gboolean purple_media_manager_unregister_element(PurpleMediaManager *manager,
const gchar *name);
gboolean purple_media_manager_set_active_element(PurpleMediaManager *manager,
PurpleMediaElementInfo *info);
/**
* purple_media_manager_get_active_element:
* @manager: The #PurpleMediaManager instance
* @type: The #PurpleMediaElementType who's info to get
*
* Returns: (transfer none): The #PurpleMediaElementInfo for @type.
*/
PurpleMediaElementInfo *purple_media_manager_get_active_element(
PurpleMediaManager *manager, PurpleMediaElementType type);
/**
* purple_media_manager_set_video_caps:
* @manager: The media manager to set the media formats.
* @caps: Set of allowed media formats.
*
* Reduces media formats supported by the video source to given set.
*
* Useful to force negotiation of smaller picture resolution more suitable for
* use with particular codec and communication protocol without rescaling.
*/
void purple_media_manager_set_video_caps(PurpleMediaManager *manager,
GstCaps *caps);
/**
* purple_media_manager_get_video_caps:
* @manager: The media manager to get the media formats from.
*
* Returns current set of media formats limiting the output from video source.
*
* Returns: GstCaps limiting the video source's formats.
*/
GstCaps *purple_media_manager_get_video_caps(PurpleMediaManager *manager);
gchar *purple_media_element_info_get_id(PurpleMediaElementInfo *info);
gchar *purple_media_element_info_get_name(PurpleMediaElementInfo *info);
PurpleMediaElementType purple_media_element_info_get_element_type(
PurpleMediaElementInfo *info);
/**
* purple_media_element_info_call_create:
* @info: The #PurpleMediaElementInfo to create the element from
* @media:
* @session_id:
* @participant:
*
* Returns: (transfer full): The new GstElement.
*/
GstElement *purple_media_element_info_call_create(
PurpleMediaElementInfo *info, PurpleMedia *media,
const gchar *session_id, const gchar *participant);
G_END_DECLS
#endif /* PURPLE_MEDIA_GST_H */