Commit d21c249b authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

media: dvb/audio.h: get rid of unused APIs



There are a number of other ioctls that aren't used anywhere
inside the Kernel tree.

Get rid of them.

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+samsung@kernel.org>
parent b41e44b4
Loading
Loading
Loading
Loading
+0 −3
Original line number Diff line number Diff line
# Ignore header name
ignore define _DVBAUDIO_H_

# Typedef pointing to structs
replace typedef audio_karaoke_t :c:type:`audio_karaoke`

# Undocumented audio caps, as this is a deprecated API anyway
ignore define AUDIO_CAP_DTS
ignore define AUDIO_CAP_LPCM
+0 −65
Original line number Diff line number Diff line
.. -*- coding: utf-8; mode: rst -*-

.. _AUDIO_GET_PTS:

=============
AUDIO_GET_PTS
=============

Name
----

AUDIO_GET_PTS

.. attention:: This ioctl is deprecated

Synopsis
--------

.. c:function:: int ioctl(int fd, AUDIO_GET_PTS, __u64 *pts)
    :name: AUDIO_GET_PTS


Arguments
---------

.. flat-table::
    :header-rows:  0
    :stub-columns: 0


    -

       -  int fd

       -  File descriptor returned by a previous call to open().

    -

       -  __u64 \*pts

       -  Returns the 33-bit timestamp as defined in ITU T-REC-H.222.0 /
	  ISO/IEC 13818-1.

	  The PTS should belong to the currently played frame if possible,
	  but may also be a value close to it like the PTS of the last
	  decoded frame or the last PTS extracted by the PES parser.


Description
-----------

This ioctl is obsolete. Do not use in new drivers. If you need this
functionality, then please contact the linux-media mailing list
(`https://linuxtv.org/lists.php <https://linuxtv.org/lists.php>`__).

This ioctl call asks the Audio Device to return the current PTS
timestamp.


Return Value
------------

On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
+0 −67
Original line number Diff line number Diff line
.. -*- coding: utf-8; mode: rst -*-

.. _AUDIO_SET_ATTRIBUTES:

====================
AUDIO_SET_ATTRIBUTES
====================

Name
----

AUDIO_SET_ATTRIBUTES

.. attention:: This ioctl is deprecated


Synopsis
--------

.. c:function:: int ioctl(fd, AUDIO_SET_ATTRIBUTES, struct audio_attributes *attr )
    :name: AUDIO_SET_ATTRIBUTES

Arguments
---------

.. flat-table::
    :header-rows:  0
    :stub-columns: 0


    -

       -  int fd

       -  File descriptor returned by a previous call to open().

    -

       -  audio_attributes_t attr

       -  audio attributes according to section ??


Description
-----------

This ioctl is intended for DVD playback and allows you to set certain
information about the audio stream.


Return Value
------------

On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.

.. flat-table::
    :header-rows:  0
    :stub-columns: 0


    -  .. row 1

       -  ``EINVAL``

       -  attr is not a valid or supported attribute setting.
+0 −66
Original line number Diff line number Diff line
.. -*- coding: utf-8; mode: rst -*-

.. _AUDIO_SET_EXT_ID:

================
AUDIO_SET_EXT_ID
================

Name
----

AUDIO_SET_EXT_ID

.. attention:: This ioctl is deprecated

Synopsis
--------

.. c:function:: int  ioctl(fd, AUDIO_SET_EXT_ID, int id)
    :name: AUDIO_SET_EXT_ID

Arguments
---------

.. flat-table::
    :header-rows:  0
    :stub-columns: 0


    -

       -  int fd

       -  File descriptor returned by a previous call to open().

    -

       -  int id

       -  audio sub_stream_id


Description
-----------

This ioctl can be used to set the extension id for MPEG streams in DVD
playback. Only the first 3 bits are recognized.


Return Value
------------

On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.

.. flat-table::
    :header-rows:  0
    :stub-columns: 0


    -  .. row 1

       -  ``EINVAL``

       -  id is not a valid id.
+0 −66
Original line number Diff line number Diff line
.. -*- coding: utf-8; mode: rst -*-

.. _AUDIO_SET_KARAOKE:

=================
AUDIO_SET_KARAOKE
=================

Name
----

AUDIO_SET_KARAOKE

.. attention:: This ioctl is deprecated

Synopsis
--------

.. c:function:: int ioctl(fd, AUDIO_SET_KARAOKE, struct audio_karaoke *karaoke)
    :name: AUDIO_SET_KARAOKE


Arguments
---------

.. flat-table::
    :header-rows:  0
    :stub-columns: 0


    -

       -  int fd

       -  File descriptor returned by a previous call to open().

    -

       -  audio_karaoke_t \*karaoke

       -  karaoke settings according to section ??.


Description
-----------

This ioctl allows one to set the mixer settings for a karaoke DVD.


Return Value
------------

On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.

.. flat-table::
    :header-rows:  0
    :stub-columns: 0


    -  .. row 1

       -  ``EINVAL``

       -  karaoke is not a valid or supported karaoke setting.
Loading