lib/picture_internal.h

   1 /*****************************************************************************
   2  * picture_internal.h:  libvlc API picture management
   3  *****************************************************************************
   4  * Copyright (C) 1998-2018 VLC authors and VideoLAN
   5  *
   6  * Authors: Hugo Beauzée-Luyssen <hugo@beauzee.fr>
   7  *
   8  * This program is free software; you can redistribute it and/or modify it
   9  * under the terms of the GNU Lesser General Public License as published by
  10  * the Free Software Foundation; either version 2.1 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16  * GNU Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public License
  19  * along with this program; if not, write to the Free Software Foundation,
  20  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  21  *****************************************************************************/
  22
  23 #ifndef PICTURE_INTERNAL_H
  24 #define PICTURE_INTERNAL_H
  25
  26 #include <vlc_picture.h>
  27
  28 /**
  29  * \brief libvlc_picture_new Wraps a libvlccore's picture_t to a libvlc_picture_t
  30  * \param p_obj A vlc object
  31  * \param p_input Input picture
  32  * \param i_type Desired converted picture type
  33  * \param i_width Converted picture width
  34  * \param i_height Converted picture height
  35  * \param b_crop Should the picture be cropped to preserve aspect ratio
  36  * \return An opaque libvlc_picture_t
  37  *
  38  * The picture refcount is left untouched by this function, but is converted to
  39  * the required format and stored as a block_t
  40  * The returned picture must be released through libvlc_picture_release
  41  */
  42 libvlc_picture_t* libvlc_picture_new( vlc_object_t* p_obj, picture_t* p_pic,
  43                                       libvlc_picture_type_t i_format,
  44                                       unsigned int i_width, unsigned int i_height,
  45                                       bool b_crop );
  46
  47 libvlc_picture_list_t* libvlc_picture_list_from_attachments( input_attachment_t** attachments,
  48                                                              size_t nb_attachments );
  49
  50 #endif /* PICTURE_INTERNAL_H */