media_attribute.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2004-2025 Savoir-faire Linux Inc.
 *
 *  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 3 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, see <https://www.gnu.org/licenses/>.
 */
#pragma once
 
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
 
#include "media/media_codec.h"
#include "jami.h"
 
namespace jami {
 
class MediaAttribute
{
public:
    MediaAttribute(MediaType type = MediaType::MEDIA_NONE,
                   bool muted = false,
                   bool secure = true,
                   bool enabled = false,
                   std::string_view source = {},
                   std::string_view label = {},
                   bool onHold = false)
        : type_(type)
        , muted_(muted)
        , secure_(secure)
        , enabled_(enabled)
        , sourceUri_(source)
        , label_(label)
        , onHold_(onHold)
    {}
 
    MediaAttribute(const libjami::MediaMap& mediaMap, bool secure);
 
    static std::vector<MediaAttribute> buildMediaAttributesList(
        const std::vector<libjami::MediaMap>& mediaList, bool secure);
 
    static MediaType stringToMediaType(const std::string& mediaType);
 
    static std::pair<bool, MediaType> getMediaType(const libjami::MediaMap& map);
 
    static std::pair<bool, bool> getBoolValue(const libjami::MediaMap& mediaMap,
                                              const std::string& key);
 
    static std::pair<bool, std::string> getStringValue(const libjami::MediaMap& mediaMap,
                                                       const std::string& key);
 
    // Return true if at least one media has a matching type.
    static bool hasMediaType(const std::vector<MediaAttribute>& mediaList, MediaType type);
 
    // Return a string of a boolean
    static char const* boolToString(bool val);
 
    // Return a string of the media type
    static char const* mediaTypeToString(MediaType type);
 
    // Convert MediaAttribute to MediaMap
    static libjami::MediaMap toMediaMap(const MediaAttribute& mediaAttr);
 
    // Serialize a vector of MediaAttribute to a vector of MediaMap
    static std::vector<libjami::MediaMap> mediaAttributesToMediaMaps(
        std::vector<MediaAttribute> mediaAttrList);
 
    std::string toString(bool full = false) const;
 
    MediaType type_ {MediaType::MEDIA_NONE};
    bool muted_ {false};
    bool secure_ {true};
    bool enabled_ {false};
    std::string sourceUri_ {};
    std::string label_ {};
    bool onHold_ {false};
 
    // NOTE: the hold and mute attributes are related but not
    // tightly coupled. A hold/unhold operation should always
    // trigger a new re-invite to notify the change in media
    // direction. For instance, on an active call, the hold action
    // would change the media direction attribute from "sendrecv"
    // to "sendonly". A new SDP with the new media direction will
    // be generated and sent to the peer in the re-invite.
    // In contrast, the mute attribute is a local attribute, and
    // describes the presence (or absence) of the media signal in
    // the stream. In other words, the mute action can be performed
    // with or without a media direction change (no re-invite).
    // For instance, muting the audio can be done by disabling the
    // audio input (capture) of the encoding session, resulting in
    // sending RTP packets without actual audio (silence).
 
    bool hasValidVideo();
};
} // namespace jami