summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid Schleef <ds@schleef.org>2014-01-07 01:01:17 -0800
committerDavid Schleef <ds@schleef.org>2014-01-07 01:01:17 -0800
commitbbca9048f4e807e7b3645fe6480898ee59ca1a45 (patch)
tree526f575502e327fb6b65821eacffb5d396b6b39b
parent14dd98fb2c16188f3b17f1f05c3cbc7efc9478f7 (diff)
Documentation fixes
-rw-r--r--doc/Makefile.am7
-rw-r--r--doc/gst-streaming-server-docs.sgml18
-rw-r--r--doc/gst-streaming-server-sections.txt476
-rw-r--r--gst-streaming-server/gss-isom-boxes.h1
-rw-r--r--gst-streaming-server/gss-isom.h8
5 files changed, 443 insertions, 67 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
index cdd865d..76e73e8 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -78,11 +78,14 @@ expand_content_files=
# signals and properties.
# e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
-GTKDOC_CFLAGS=$(GSS_CFLAGS) $(GST_CFLAGS) $(SOUP_CFLAGS) $(GST_RTSP_SERVER_CFLAGS)
+GTKDOC_CFLAGS=-include gst-helper.h $(GSS_CFLAGS) $(GST_CFLAGS) $(SOUP_CFLAGS) $(GST_RTSP_SERVER_CFLAGS)
GTKDOC_LIBS=$(top_builddir)/gst-streaming-server/libgss-@GST_API_VERSION@.la $(GST_LIBS) $(SOUP_LIBS) $(GST_RTSP_SERVER_LIBS) $(JSON_GLIB_LIBS)
+GTKDOC_CC=$(LIBTOOL) --tag=CC --mode=compile $(CC)
+GTKDOC_LD=$(LIBTOOL) --tag=CC --mode=link $(CC)
+
# This includes the standard gtk-doc make rules, copied by gtkdocize.
-include $(top_srcdir)/gtk-doc.make
+include $(top_srcdir)/common/gtk-doc.mak
# Other files to distribute
# e.g. EXTRA_DIST += version.xml.in
diff --git a/doc/gst-streaming-server-docs.sgml b/doc/gst-streaming-server-docs.sgml
index 4b2247b..59d5fe6 100644
--- a/doc/gst-streaming-server-docs.sgml
+++ b/doc/gst-streaming-server-docs.sgml
@@ -2,6 +2,8 @@
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
[
+ <!ENTITY % version-entities SYSTEM "version.entities">
+ %version-entities;
<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
]>
<book id="index">
@@ -19,19 +21,33 @@
</chapter>
<chapter>
<title>GSS Library Reference</title>
+ <xi:include href="xml/gss-adaptive.xml"/>
+ <xi:include href="xml/gss-addr-range.xml"/>
+ <xi:include href="xml/gss-box.xml"/>
<xi:include href="xml/gss-config.xml"/>
- <xi:include href="xml/gss-form.xml"/>
+ <xi:include href="xml/gss-drm.xml"/>
<xi:include href="xml/gss-html.xml"/>
+ <xi:include href="xml/gss-isom.xml"/>
+ <xi:include href="xml/gss-json.xml"/>
+ <xi:include href="xml/gss-log.xml"/>
+ <xi:include href="xml/gss-manager.xml"/>
<xi:include href="xml/gss-metrics.xml"/>
+ <xi:include href="xml/gss-module.xml"/>
+ <xi:include href="xml/gss-object.xml"/>
+ <xi:include href="xml/gss-playready.xml"/>
<xi:include href="xml/gss-program.xml"/>
+ <xi:include href="xml/gss-pull.xml"/>
+ <xi:include href="xml/gss-push.xml"/>
<xi:include href="xml/gss-resource.xml"/>
<xi:include href="xml/gss-rtsp.xml"/>
<xi:include href="xml/gss-server.xml"/>
<xi:include href="xml/gss-session.xml"/>
+ <xi:include href="xml/gss-sglist.xml"/>
<xi:include href="xml/gss-soup.xml"/>
<xi:include href="xml/gss-stream.xml"/>
<xi:include href="xml/gss-transaction.xml"/>
<xi:include href="xml/gss-types.xml"/>
+ <xi:include href="xml/gss-user.xml"/>
<xi:include href="xml/gss-utils.xml"/>
<xi:include href="xml/gss-vod.xml"/>
<xi:include href="xml/gss-websocket.xml"/>
diff --git a/doc/gst-streaming-server-sections.txt b/doc/gst-streaming-server-sections.txt
index 6ba23f2..3be6cdd 100644
--- a/doc/gst-streaming-server-sections.txt
+++ b/doc/gst-streaming-server-sections.txt
@@ -1,53 +1,84 @@
<SECTION>
+<FILE>gss-log</FILE>
+GssErrorEnum
+gss_log_send_syslog
+gss_log_set_verbosity
+gss_log_transaction
+gss_log_init
+</SECTION>
+
+<SECTION>
+<FILE>gss</FILE>
+gss_init
+gss_deinit
+</SECTION>
+
+<SECTION>
<FILE>gss-config</FILE>
GssConfig
-GssConfigDefault
-GssConfigField
-GssConfigNotifyFunc
-gss_config_check_config_file
-gss_config_exists
-gss_config_free
-gss_config_get
-gss_config_get_boolean
-gss_config_get_int
+GssConfigClass
+gss_config_add_server_resources
+gss_config_append_config_block
+gss_config_attach
+gss_config_create_object
+gss_config_create_object_2
+gss_config_get_post_hash
+gss_config_get_type
gss_config_handle_post
-gss_config_hash_to_string
-gss_config_load_defaults
-gss_config_load_from_file
-gss_config_load_from_file_locked
-gss_config_lock
-gss_config_new
-gss_config_set
-gss_config_set_config_filename
-gss_config_set_flags
-gss_config_set_notify
-gss_config_value_is_equal
-gss_config_value_is_on
-gss_config_write_config_to_file
-</SECTION>
-
-<SECTION>
-<FILE>gss-form</FILE>
-GSS_FORM_NUM_OPTIONS
-GssField
-GssFieldType
-GssOption
-gss_config_form_add_checkbox
-gss_config_form_add_enable
-gss_config_form_add_file
-gss_config_form_add_form
-gss_config_form_add_hidden
-gss_config_form_add_password
-gss_config_form_add_radio
-gss_config_form_add_select
-gss_config_form_add_submit
-gss_config_form_add_text_input
+gss_config_handle_post_hash
+gss_config_load_config_file
+gss_config_load_object
+gss_config_post_resource
+gss_config_save_config_file
+gss_config_save_object
+<SUBSECTION Standard>
+GSS_IS_CONFIG
+GSS_IS_CONFIG_CLASS
+GSS_CONFIG
+GSS_CONFIG_CLASS
+GSS_CONFIG_GET_CLASS
+GSS_TYPE_CONFIG
+gss_config_get_type
+</SECTION>
+
+<SECTION>
+<FILE>gss-adaptive</FILE>
+GSS_ADAPTIVE_KEY_LENGTH
+GssAdaptive
+GssAdaptiveLevel
+GssAdaptiveQuery
+GssAdaptiveStream
+gss_adaptive_free
+gss_adaptive_get_level
+gss_adaptive_get_resource
+gss_adaptive_get_stream_type
+gss_adaptive_load
+gss_adaptive_new
+gss_adaptive_stream_get_name
+</SECTION>
+
+<SECTION>
+<FILE>gss-addr-range</FILE>
+GssAddrRangeList
+gss_addr_range_list_check_address
+gss_addr_range_list_free
+gss_addr_range_list_new
+gss_addr_range_list_new_from_string
+</SECTION>
+
+<SECTION>
+<FILE>gss-drm</FILE>
+GssDrmInfo
+GssDrmType
+gss_drm_get_drm_name
+gss_drm_get_drm_type
+gss_drm_get_drm_uuid
</SECTION>
<SECTION>
<FILE>gss-html</FILE>
-USE_HTML5
-gss_html_append_break
+GSS_A
+GSS_P
gss_html_append_image
gss_html_append_image_printf
gss_html_attribute_is_sane
@@ -60,6 +91,163 @@ gss_html_sanitize_attribute
gss_html_sanitize_entity
gss_html_sanitize_url
gss_html_url_is_sane
+gss_html_append_button
+gss_html_append_button2
+gss_html_append_button3
+gss_html_append_button_target
+gss_html_error_401
+gss_html_error_405
+gss_html_footer_bare
+gss_html_header_bare
+</SECTION>
+
+<SECTION>
+<FILE>gss-box</FILE>
+GssBoxAinf
+GssBoxAvcn
+GssBoxCprt
+GssBoxCtts
+GssBoxCttsEntry
+GssBoxDinf
+GssBoxDref
+GssBoxDrefEntry
+GssBoxEdts
+GssBoxElst
+GssBoxElstEntry
+GssBoxEsds
+GssBoxHdlr
+GssBoxHmhd
+GssBoxIlst
+GssBoxIods
+GssBoxMdhd
+GssBoxMdia
+GssBoxMdir
+GssBoxMehd
+GssBoxMeta
+GssBoxMfhd
+GssBoxMinf
+GssBoxMoof
+GssBoxMoov
+GssBoxMp4a
+GssBoxMp4s
+GssBoxMp4v
+GssBoxMvex
+GssBoxMvhd
+GssBoxParser
+GssBoxPssh
+GssBoxSaio
+GssBoxSaiz
+GssBoxSdtp
+GssBoxSidx
+GssBoxSidxEntry
+GssBoxSinf
+GssBoxSkip
+GssBoxSmhd
+GssBoxStbl
+GssBoxStco
+GssBoxStdp
+GssBoxStore
+GssBoxStsc
+GssBoxStscEntry
+GssBoxStsd
+GssBoxStsdEntry
+GssBoxStsh
+GssBoxStshEntry
+GssBoxStss
+GssBoxStsz
+GssBoxStts
+GssBoxSttsEntry
+GssBoxTfdt
+GssBoxTfhd
+GssBoxTkhd
+GssBoxTraf
+GssBoxTrak
+GssBoxTref
+GssBoxTrex
+GssBoxTrik
+GssBoxTrun
+GssBoxTrunSample
+GssBoxUUIDProtectionHeader
+GssBoxUUIDSampleEncryption
+GssBoxUUIDSampleEncryptionSample
+GssBoxUUIDSampleEncryptionSampleEntry
+GssBoxUdta
+GssBoxUrl_
+GssBoxUrn_
+GssBoxVmhd
+</SECTION>
+
+<SECTION>
+<FILE>gss-isom</FILE>
+GssIsomFragment
+GssIsomFtyp
+GssIsomMovie
+GssIsomParser
+GssIsomSample
+GssIsomSampleIterator
+GssIsomTrack
+gss_isom_encrypt_samples
+gss_isom_fragment_dump
+gss_isom_fragment_free
+gss_isom_fragment_get_n_samples
+gss_isom_fragment_get_sample_sizes
+gss_isom_fragment_new
+gss_isom_fragment_serialize
+gss_isom_fragment_set_sample_encryption
+gss_isom_movie_dump
+gss_isom_movie_free
+gss_isom_movie_get_audio_track
+gss_isom_movie_get_duration
+gss_isom_movie_get_track_by_id
+gss_isom_movie_get_video_track
+gss_isom_movie_new
+gss_isom_movie_serialize
+gss_isom_movie_serialize_track_ccff
+gss_isom_movie_serialize_track_dash
+gss_isom_parser_dump
+gss_isom_parser_fragmentize
+gss_isom_parser_free
+gss_isom_parser_new
+gss_isom_parser_parse_file
+gss_isom_sample_iter_get_sample
+gss_isom_sample_iter_init
+gss_isom_sample_iter_iterate
+gss_isom_track_convert_h264_codec_data
+gss_isom_track_dump
+gss_isom_track_get_fragment
+gss_isom_track_get_fragment_by_timestamp
+gss_isom_track_get_index_from_timestamp
+gss_isom_track_get_n_samples
+gss_isom_track_get_sample
+gss_isom_track_is_audio
+gss_isom_track_is_video
+gss_isom_track_prepare_streaming
+gss_isom_track_serialize_dash
+</SECTION>
+
+<SECTION>
+<FILE>gss-json</FILE>
+gss_json_gobject_to_data
+</SECTION>
+
+<SECTION>
+<FILE>gss-manager</FILE>
+gss_manager_create_pipeline
+gss_manager_get_type
+gss_manager_new
+gss_manager_set_location
+gss_manager_start
+gss_manager_stop
+<SUBSECTION Standard>
+GssManager
+GssManagerClass
+GSS_IS_MANAGER
+GSS_IS_MANAGER_CLASS
+GSS_MANAGER
+GSS_MANAGER_CLASS
+GSS_MANAGER_GET_CLASS
+GSS_TYPE_MANAGER
+gss_manager_get_type
</SECTION>
<SECTION>
@@ -72,16 +260,81 @@ gss_metrics_remove_client
</SECTION>
<SECTION>
+<FILE>gss-module</FILE>
+gss_module_get_type
+gss_module_set_admin_resource
+<SUBSECTION Standard>
+GssModule
+GssModuleClass
+GSS_IS_MODULE
+GSS_IS_MODULE_CLASS
+GSS_MODULE
+GSS_MODULE_CLASS
+GSS_MODULE_GET_CLASS
+GSS_TYPE_MODULE
+gss_module_get_type
+</SECTION>
+
+<SECTION>
+<FILE>gss-object</FILE>
+GSS_OBJECT_NAME
+GSS_OBJECT_SAFE_TITLE
+GSS_OBJECT_SERVER
+GSS_OBJECT_TITLE
+gss_object_get_type
+gss_object_param_is_secure
+gss_object_set_automatic_name
+gss_object_set_name
+gss_object_set_title
+GSS_PARAM_FILE_UPLOAD
+GSS_PARAM_HIDE
+GSS_PARAM_MULTILINE
+GSS_PARAM_SECURE
+<SUBSECTION Standard>
+GssObject
+GssObjectClass
+GSS_IS_OBJECT
+GSS_IS_OBJECT_CLASS
+GSS_OBJECT
+GSS_OBJECT_CLASS
+GSS_OBJECT_GET_CLASS
+GSS_TYPE_OBJECT
+gss_object_get_type
+</SECTION>
+
+<SECTION>
+<FILE>gss-playready</FILE>
+gss_playready_add_protection_header
+gss_playready_encrypt_samples
+gss_playready_generate_key
+gss_playready_get_key_seed_hex
+gss_playready_get_protection_header
+gss_playready_get_protection_header_base64
+gss_playready_new
+gss_playready_set_key_seed_hex
+gss_playready_setup
+gss_playready_setup_iv
+<SUBSECTION Standard>
+GssPlayready
+GssPlayreadyClass
+GSS_IS_PLAYREADY
+GSS_IS_PLAYREADY_CLASS
+GSS_PLAYREADY
+GSS_PLAYREADY_CLASS
+GSS_PLAYREADY_GET_CLASS
+GSS_TYPE_PLAYREADY
+gss_playready_get_type
+</SECTION>
+
+<SECTION>
<FILE>gss-program</FILE>
<TITLE>GssProgram</TITLE>
GssProgram
GssProgramClass
GssProgramState
-GssProgramType
gss_program_add_hls_stream
gss_program_add_jpeg_block
gss_program_add_ogv_stream
-gss_program_add_server_resources
gss_program_add_stream
gss_program_add_stream_follow
gss_program_add_stream_full
@@ -99,7 +352,6 @@ gss_program_get_stream_index
gss_program_http_follow
gss_program_http_put
gss_program_icecast
-gss_program_log
gss_program_new
gss_program_remove_server_resources
gss_program_remove_stream
@@ -109,6 +361,9 @@ gss_program_set_state
gss_program_start
gss_program_state_get_name
gss_program_stop
+gss_program_get_resource
+gss_program_idle_start
+gss_program_idle_stop
<SUBSECTION Standard>
GSS_IS_PROGRAM
GSS_IS_PROGRAM_CLASS
@@ -120,6 +375,39 @@ gss_program_get_type
</SECTION>
<SECTION>
+<FILE>gss-pull</FILE>
+gss_pull_get_type
+gss_pull_new
+<SUBSECTION Standard>
+GssPull
+GssPullClass
+GSS_IS_PULL
+GSS_IS_PULL_CLASS
+GSS_PULL
+GSS_PULL_CLASS
+GSS_PULL_GET_CLASS
+GSS_TYPE_PULL
+gss_pull_get_type
+</SECTION>
+
+<SECTION>
+<FILE>gss-push</FILE>
+gss_push_get_type
+gss_push_new
+GssPushMethod
+<SUBSECTION Standard>
+GssPush
+GssPushClass
+GSS_IS_PUSH
+GSS_IS_PUSH_CLASS
+GSS_PUSH
+GSS_PUSH_CLASS
+GSS_PUSH_GET_CLASS
+GSS_TYPE_PUSH
+gss_push_get_type
+</SECTION>
+
+<SECTION>
<FILE>gss-resource</FILE>
GssResource
GssResourceFlags
@@ -148,7 +436,6 @@ gss_server_rtsp_init
GssServer
GssServerClass
gss_server_add_admin_callbacks
-gss_server_add_admin_resource
gss_server_add_featured_resource
gss_server_add_file_resource
gss_server_add_program
@@ -160,19 +447,20 @@ gss_server_add_static_resource
gss_server_add_static_string
gss_server_add_string_resource
gss_server_add_warnings_callback
-gss_server_deinit
gss_server_disable_programs
gss_server_follow_all
gss_server_get_multifdsink_string
gss_server_get_program_by_name
-gss_server_log
gss_server_new
-gss_server_read_config
gss_server_remove_program
gss_server_remove_resource
gss_server_set_footer_html
gss_server_set_server_hostname
gss_server_set_title
+gss_server_add_module
+gss_server_create_module
+gss_server_remove_resources_by_priv
+gss_server_set_realm
<SUBSECTION Standard>
GSS_IS_SERVER
GSS_IS_SERVER_CLASS
@@ -198,11 +486,23 @@ gss_session_login_callback
gss_session_logout_callback
gss_session_lookup
gss_session_new
-gss_session_notify_hosts_allow
gss_session_ref
gss_session_set_authorization_function
gss_session_touch
gss_session_unref
+gss_session_is_producer
+gss_session_set_hosts_allow
+</SECTION>
+
+<SECTION>
+<FILE>gss-sglist</FILE>
+GssSGChunk
+GssSGList
+gss_sglist_free
+gss_sglist_get_size
+gss_sglist_load
+gss_sglist_merge
+gss_sglist_new
</SECTION>
<SECTION>
@@ -210,8 +510,7 @@ gss_session_unref
gss_soup_get_base_url_http
gss_soup_get_base_url_https
gss_soup_get_request_host
-gss_transaction_get_base_url
-gss_transaction_is_secure
+gss_soup_dump_request_headers
</SECTION>
<SECTION>
@@ -228,8 +527,6 @@ GssStreamType
gss_stream_add_fd
gss_stream_add_hls
gss_stream_add_resources
-gss_stream_create_follow_pipeline
-gss_stream_create_push_pipeline
gss_stream_get_stats
gss_stream_handle_m3u8
gss_stream_new
@@ -243,6 +540,7 @@ gss_stream_type_get_ext
gss_stream_type_get_id
gss_stream_type_get_mod
gss_stream_type_get_name
+gss_stream_type_get_type
<SUBSECTION Standard>
GSS_IS_STREAM
GSS_IS_STREAM_CLASS
@@ -255,6 +553,16 @@ gss_stream_get_type
<SECTION>
<FILE>gss-transaction</FILE>
GssTransaction
+gss_transaction_delay
+gss_transaction_dump
+gss_transaction_error
+gss_transaction_error_not_found
+gss_transaction_free
+gss_transaction_new
+gss_transaction_process_async
+gss_transaction_redirect
+gss_transaction_get_base_url
+gss_transaction_is_secure
</SECTION>
<SECTION>
@@ -273,17 +581,59 @@ GssTransaction
</SECTION>
<SECTION>
+<FILE>gss-user</FILE>
+gss_user_add_user_info
+gss_user_get_string
+gss_user_get_type
+gss_user_new
+gss_user_parse_users_string
+gss_user_set_location
+<SUBSECTION Standard>
+GssUser
+GssUserClass
+GssUserInfo
+GSS_IS_USER
+GSS_IS_USER_CLASS
+GSS_USER
+GSS_USER_CLASS
+GSS_TYPE_USER
+gss_user_get_type
+</SECTION>
+
+<SECTION>
<FILE>gss-utils</FILE>
+GSS_CLEANUP
+GSS_TEXT_HTML
+GSS_TEXT_PLAIN
+gss_base64url_encode
+gss_hex_encode
gss_utils_dump_hash
gss_utils_get_ip_address_string
gss_utils_get_random_bytes
gss_utils_get_time_string
gss_utils_gethostname
+gss_utils_crlf_to_lf
+gss_uuid_create
+gss_uuid_to_string
+g_object_get_as_string
+g_object_property_is_default
+g_object_set_as_string
</SECTION>
<SECTION>
<FILE>gss-vod</FILE>
-gss_vod_setup
+gss_vod_get_type
+gss_vod_new
+<SUBSECTION Standard>
+GssVod
+GssVodClass
+GSS_IS_VOD
+GSS_IS_VOD_CLASS
+GSS_VOD_GET_CLASS
+GSS_VOD
+GSS_VOD_CLASS
+GSS_TYPE_VOD
+gss_vod_get_type
</SECTION>
<SECTION>
@@ -301,3 +651,19 @@ GSS_TYPE_WEBSOCKET
gss_websocket_get_type
</SECTION>
+<SECTION>
+<FILE>junk</FILE>
+gss_data_bootstrap_css_len
+gss_data_bootstrap_js_len
+gss_data_bootstrap_responsive_css_len
+gss_data_dash_min_js_len
+gss_data_footer_entropywave_png_len
+gss_data_glyphicons_halflings_png_len
+gss_data_glyphicons_halflings_white_png_len
+gss_data_include_js_len
+gss_data_jquery_js_len
+gss_data_no_snapshot_jpg_len
+gss_data_offline_jpg_len
+gss_data_sign_in_blue_png_len
+</SECTION>
+
diff --git a/gst-streaming-server/gss-isom-boxes.h b/gst-streaming-server/gss-isom-boxes.h
index 9c9d5e8..b4197c5 100644
--- a/gst-streaming-server/gss-isom-boxes.h
+++ b/gst-streaming-server/gss-isom-boxes.h
@@ -166,7 +166,6 @@ struct _GssBoxUUIDSampleEncryption
GssBoxUUIDSampleEncryptionSample *samples;
};
-#define MAX_IV_SIZE 16
struct _GssBoxUUIDSampleEncryptionSample
{
guint64 iv;
diff --git a/gst-streaming-server/gss-isom.h b/gst-streaming-server/gss-isom.h
index 5a0c7d5..e3f7827 100644
--- a/gst-streaming-server/gss-isom.h
+++ b/gst-streaming-server/gss-isom.h
@@ -33,7 +33,6 @@ typedef struct _GssIsomMovie GssIsomMovie;
typedef struct _GssIsomParser GssIsomParser;
typedef struct _GssIsomSample GssIsomSample;
typedef struct _GssIsomSampleIterator GssIsomSampleIterator;
-typedef struct _GssChunk GssChunk;
typedef enum
{
@@ -47,13 +46,6 @@ typedef enum
GSS_ISOM_FTYP_ISO6 = (1 << 7),
} GssIsomFtyp;
-struct _GssChunk {
- guint64 offset;
- guint64 size;
- guint64 source_offset;
- guint8 *data;
-};
-
struct _GssIsomFragment {
int track_id;
guint64 offset;