# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.

# Adding a new metric? We have docs for that!
# https://firefox-source-docs.mozilla.org/toolkit/components/glean/user/new_definitions_file.html

---
$schema: moz://mozilla.org/schemas/glean/metrics/2-0-0
$tags:
  - 'Core :: Audio/Video'

mfcdm:
  eme_playback:
    type: event
    description:
      Record the information about the EME playback when using the media engine.
      The value of this event is the key system name.
    metadata:
      tags:
        - 'Core :: Audio/Video: Playback'
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1873394
      - https://bugzilla.mozilla.org/show_bug.cgi?id=2026435
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1873394#c7
    data_sensitivity:
      - technical
    notification_emails:
      - media-alerts@mozilla.com
    extra_keys:
      key_system:
        description: The key system used for the EME playback
        type: string
      video_codec:
        description: The video codec used for EME playback
        type: string
      resolution:
        description: The video resolution used for EME playback
        type: string
      played_time:
        description: The amount of time (in seconds) the EME content has been played (in seconds)
        type: quantity
      rendered_frames:
        description: The amount of video frames has been rendered
        type: quantity
      dropped_frames:
        description: The amount of video frames don't get rendered but dropped
        type: quantity
    expires: 158
    telemetry_mirror: Mfcdm_EmePlayback_Gecko
  error:
    type: event
    description:
      Record the error or crash happened while using the media engine playback.
      The value of this event is the name of error. This probe covers both EME
      and non-EME playback.
    metadata:
      tags:
        - 'Core :: Audio/Video: Playback'
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1873394
      - https://bugzilla.mozilla.org/show_bug.cgi?id=2026435
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1873394#c7
    data_sensitivity:
      - technical
    notification_emails:
      - media-alerts@mozilla.com
    extra_keys:
      error_name:
        description: The name of the error
        type: string
      current_state:
        description: The state of the external state machine was being used when the error or crash happened
        type: string
      audio_codec:
        description: The audio codec was being used when the error or crash happened
        type: string
      video_codec:
        description: The video codec was being used when the error or crash happened
        type: string
      resolution:
        description: The video resolution was being used when the error or crash happened
        type: string
      key_system:
        description: The key system was being used when the error or crash happened
        type: string
      platform_error:
        description: The platform specific error code, eg. HResult on Windows
        type: quantity
    expires: 158
    telemetry_mirror: Mfcdm_Error_Gecko

media:
  wmf_codec_no_extension:
    type: labeled_boolean
    description: >
      Set to true for a given codec when its required Windows Store extension
      is not installed (WINCODEC_ERR_COMPONENTNOTFOUND during WMF decoder
      initialization). Recorded once per session. Not recorded when the codec
      is disabled by pref or DXVA is unavailable.
    labels:
      - av1
      - hevc
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1990057
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1990057
    data_sensitivity:
      - technical
    notification_emails:
      - media-alerts@mozilla.com
    expires: never

  decoder_backend_used:
    type: custom_distribution
    description: >
      Media decoder backend (0=WMF Software, 1=DXVA2D3D9, 2=DXVA2D3D11)

      This metric was generated to correspond to the Legacy Telemetry enumerated
      histogram MEDIA_DECODER_BACKEND_USED.
    range_min: 0
    range_max: 10
    bucket_count: 11
    histogram_type: linear
    bugs:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1259695
    data_reviews:
      - https://bugzilla.mozilla.org/show_bug.cgi?id=1259695
    notification_emails:
      - gfx-telemetry-alerts@mozilla.com
      - rhunt@mozilla.com
    expires: never
    telemetry_mirror: MEDIA_DECODER_BACKEND_USED